From 1b03ed73b887d114d38bea239d11dd653032387e Mon Sep 17 00:00:00 2001 From: pyup-bot Date: Sun, 18 Aug 2019 20:00:15 +0100 Subject: [PATCH 01/40] Update ruamel.yaml from 0.15.94 to 0.16.5 --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 816db58c..7a62466a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -15,7 +15,7 @@ requests[security]>=2.18 # urllib3 is handled by requests # Import Export and Utils implementation -ruamel.yaml==0.15.94 +ruamel.yaml==0.16.5 deepdiff>=3.3.0,<4.0 # pyup: ignore # Demo deployment automation From bc355dfa0f14423e83c411cd78750ee2783c1d49 Mon Sep 17 00:00:00 2001 From: Nicolas Delsaux Date: Wed, 2 Oct 2019 17:23:41 +0200 Subject: [PATCH 02/40] Fixes #151 : it is now possible to have process group level policies applied to a group instead of a user --- nipyapi/security.py | 49 +++++++++++++++++++++++++++++++-------------- 1 file changed, 34 insertions(+), 15 deletions(-) diff --git a/nipyapi/security.py b/nipyapi/security.py index 60514eb8..38eef6b1 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -749,11 +749,11 @@ def set_service_ssl_context( nipyapi.config.nifi_config.ssl_context = ssl_context -def bootstrap_security_policies(service, user_identity=None): +def bootstrap_security_policies(service, user_identity=None, group_identity=None): assert service in _valid_services if 'nifi' in service: rpg_id = nipyapi.canvas.get_root_pg_id() - if user_identity is None: + if user_identity is None and group_identity is None: nifi_user_identity = nipyapi.security.get_service_user( nipyapi.config.default_nifi_username, service='nifi' @@ -775,14 +775,25 @@ def bootstrap_security_policies(service, user_identity=None): service='nifi', auto_create=True ) - nipyapi.security.add_user_to_access_policy( - user=nifi_user_identity, - policy=ap, - service='nifi', - strict=False - ) + if nifi_user_identity is None: + # I should not rely upon a try/catch there, but it's the simplest way (I just hope it won't break the server :-) ) + try: + nipyapi.security.add_user_group_to_access_policy( + user_group=group_identity, + policy=ap, + service='nifi' + ) + except: + pass + else: + nipyapi.security.add_user_to_access_policy( + user=nifi_user_identity, + policy=ap, + service='nifi', + strict=False + ) else: - if user_identity is None: + if user_identity is None and group_identity is None: reg_user_identity = nipyapi.security.get_service_user( nipyapi.config.default_registry_username, service='registry' @@ -801,12 +812,20 @@ def bootstrap_security_policies(service, user_identity=None): service='registry', auto_create=True ) - nipyapi.security.add_user_to_access_policy( - user=reg_user_identity, - policy=pol, - service='registry', - strict=False - ) + if reg_user_identity is None: + nipyapi.security.add_user_group_to_access_policy( + user=group_identity, + policy=pol, + service='registry', + strict=False + ) + else: + nipyapi.security.add_user_to_access_policy( + user=reg_user_identity, + policy=pol, + service='registry', + strict=False + ) # Setup Proxy Access nifi_proxy = nipyapi.security.create_service_user( identity=nipyapi.config.default_proxy_user, From d436af54dce4ff027b0723905241924f2ef20843 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Mon, 7 Oct 2019 11:37:09 +0100 Subject: [PATCH 03/40] Minor coding style fixes to config, security Added docstring for documentation to security/bootstrap_security_policies Corrected Version Support in Readme Updated Tox config to use latest Python3 version instead of pinning 3.6 --- README.rst | 6 +++--- nipyapi/config.py | 5 ++++- nipyapi/security.py | 29 ++++++++++++++++++----------- tox.ini | 7 ++++--- 4 files changed, 29 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index bdea794f..929e6671 100644 --- a/README.rst +++ b/README.rst @@ -97,12 +97,12 @@ Background and Documentation NiFi Version Support -------------------- -| Currently we are testing against NiFi versions 1.1.2 - 1.9.1, and NiFi-Registry versions 0.1.0 - 0.3.0. +| Currently we are testing against NiFi versions 1.1.2 - 1.9.2, and NiFi-Registry versions 0.1.0 - 0.3.0. | If you find a version compatibility problem please raise an `issue `_ Python Requirements ------------------- -| Python 2.7 or 3.4-6 supported, though other versions may work. -| Tested on Centos and OSX 10.14.x - Windows automated testing not attempted +| Python 2.7 or 3.4-7 supported, though other versions may work. *We will shortly stop supporting Python2* +| 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 and ruamel.yaml in processing, and Docker for demo/tests. diff --git a/nipyapi/config.py b/nipyapi/config.py index 25a635ca..eb9eb1ce 100644 --- a/nipyapi/config.py +++ b/nipyapi/config.py @@ -27,7 +27,10 @@ # Set Default Host for NiFi default_host = 'localhost' # Default to localhost for release # -nifi_config.host = os.getenv('NIFI_API_ENDPOINT', 'http://' + default_host + ':8080/nifi-api') +nifi_config.host = os.getenv( + 'NIFI_API_ENDPOINT', + 'http://' + default_host + ':8080/nifi-api' +) # Set Default Host for NiFi-Registry registry_config.host = 'http://' + default_host + ':18080/nifi-registry-api' diff --git a/nipyapi/security.py b/nipyapi/security.py index 60514eb8..5af6b068 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -299,7 +299,6 @@ def service_login(service='nifi', username=None, password=None, log_args = locals() log_args['password'] = 'REDACTED' log.info("Called service_login with args %s", log_args) - # TODO: Tidy up logging and automate sensitive value redaction assert service in _valid_services assert username is None or isinstance(username, six.string_types) assert password is None or isinstance(password, six.string_types) @@ -425,16 +424,15 @@ def get_service_access_status(service='nifi', bool_response=False): return False log.debug("- bool_response is False, raising Exception") raise e - except nipyapi.nifi.api_client.ApiException as e: - if 'only supported when running over HTTPS' in e.body: - return False - raise e except getattr(nipyapi, service).rest.ApiException as e: - if 'Authentication object was not found' in e.body: + expected_errors = [ + 'Authentication object was not found', + 'only supported when running over HTTPS' + ] + if any(x in e.body for x in expected_errors): if bool_response: return False - else: - raise e + raise e def add_user_to_access_policy(user, policy, service='nifi', refresh=True, @@ -493,9 +491,8 @@ def add_user_to_access_policy(user, policy, service='nifi', refresh=True, policy_tgt.component.users.append({'id': user_id}) return nipyapi.security.update_access_policy(policy_tgt, service) - else: - if strict and user_id in policy_user_ids: - raise ValueError("Strict is True and User ID already in Policy") + if strict and user_id in policy_user_ids: + raise ValueError("Strict is True and User ID already in Policy") def add_user_group_to_access_policy(user_group, policy, service='nifi', @@ -750,6 +747,16 @@ def set_service_ssl_context( def bootstrap_security_policies(service, user_identity=None): + """ + Creates a default security context within NiFi or Nifi-Registry + + Args: + service (str): 'nifi' or 'registry' to indicate which service + user_identity: a service user to establish in the security context + + Returns: + + """ assert service in _valid_services if 'nifi' in service: rpg_id = nipyapi.canvas.get_root_pg_id() diff --git a/tox.ini b/tox.ini index 566db08e..b59a801f 100644 --- a/tox.ini +++ b/tox.ini @@ -1,9 +1,9 @@ [tox] -envlist = py27, py36, flake8, lint +envlist = py27, py3, flake8, lint [travis] python = - 3.6: py36 + 3: py3 2.7: py27 [flake8] @@ -20,7 +20,8 @@ commands= [testenv:flake8] basepython=python3 -deps=flake8>=3.6.0 +deps=flake8>=3 +ignore=R0801 commands= flake8 nipyapi From effa825d8a97e70a536c38e2ee0542f46cf7ed44 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Mon, 7 Oct 2019 12:02:17 +0100 Subject: [PATCH 04/40] Security.py flake cleanup --- nipyapi/security.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/nipyapi/security.py b/nipyapi/security.py index 6bb7cff7..ed9ac8cc 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -663,6 +663,8 @@ def create_access_policy(resource, action, r_id=None, service='nifi'): assert service in _valid_services if resource[0] != '/': r = '/' + resource + else: + r = resource try: if service == 'nifi': return nipyapi.nifi.PoliciesApi().create_access_policy( @@ -753,8 +755,10 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None Args: 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 """ assert service in _valid_services @@ -783,7 +787,8 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None auto_create=True ) if nifi_user_identity is None: - # I should not rely upon a try/catch there, but it's the simplest way (I just hope it won't break the server :-) ) + # I should not rely upon a try/catch there + # but it's the simplest way (I just hope it won't break the server :-) ) try: nipyapi.security.add_user_group_to_access_policy( user_group=group_identity, From 062e86518c34c3cee17dfb1c51484a90ec157726 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Mon, 7 Oct 2019 16:57:06 +0100 Subject: [PATCH 05/40] Resolve twine version dependency --- requirements_dev.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements_dev.txt b/requirements_dev.txt index 55a06b0d..2eef6cf4 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -5,7 +5,7 @@ pip>=9.0.1 # Project management and Deployment bumpversion>=0.5.3 watchdog>=0.8.3 -twine>=1.9.1 +twine>=1.9.1,<2.0.0 virtualenvwrapper>=4.8 # Testing From 381a50b91a198044648e416ff78db364ffba49c5 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Mon, 7 Oct 2019 17:40:25 +0100 Subject: [PATCH 06/40] Resolve lxml version dependency - committing separately to allow cherry picking --- requirements.txt | 2 +- requirements_dev.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 7a62466a..7e6b8ec7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -8,7 +8,7 @@ six>=1.11.0 packaging>=17.1 # Templates management implementation -lxml>=4.1.1 +lxml>=4.1.1,<4.4.0 # pyup: ignore # Security and Connectivity requests[security]>=2.18 diff --git a/requirements_dev.txt b/requirements_dev.txt index 2eef6cf4..f4c1854e 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -5,7 +5,7 @@ pip>=9.0.1 # Project management and Deployment bumpversion>=0.5.3 watchdog>=0.8.3 -twine>=1.9.1,<2.0.0 +twine>=1.9.1,<2.0.0 # pyup: ignore virtualenvwrapper>=4.8 # Testing From fc601b3652d447fbc45aa2269a021609f652af59 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Mon, 7 Oct 2019 17:52:52 +0100 Subject: [PATCH 07/40] deprecate Python-3.4 support to maintain n-2 compatibility efforts --- .travis.yml | 1 - README.rst | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index d10a47df..78064bb9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,7 +10,6 @@ language: python matrix: include: - python: 2.7 - - python: 3.4 - python: 3.5 - python: 3.6 - python: 3.7 diff --git a/README.rst b/README.rst index 929e6671..c120ca0b 100644 --- a/README.rst +++ b/README.rst @@ -103,6 +103,6 @@ NiFi Version Support Python Requirements ------------------- -| Python 2.7 or 3.4-7 supported, though other versions may work. *We will shortly stop supporting Python2* +| Python 2.7 or 3.5-7 supported, though other versions may work. *We will shortly stop supporting Python2* | 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 and ruamel.yaml in processing, and Docker for demo/tests. From 78460a7b4cafbb95420bbb8be435e8c29f9bdb64 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Wed, 9 Oct 2019 14:55:56 +0100 Subject: [PATCH 08/40] Merge bugfixes from Next to Master for 0.13.3 release (#158) * Fixes #155 * Fixes #149 * Fixes #153 Note this is a workaround for the upstream NiFi Swagger definition bug * Fixes #150 by reimplementing recursive code as fast iterator Fixes #147 with same implementation, though similar cause Further timeout issues may need to be addressed with timeout configuration controls * Implemented utils.rest_exceptions to wrap normal Rest exception raising Modified Linting ignore list to remove noise Linting fixes for relevant complaints Corrected Exception testing to reflect tidied up exception raising * Update Coverage configuration --- nipyapi/canvas.py | 235 +++++++++--------- nipyapi/demo/console.py | 4 +- ...oller_service_referencing_component_dto.py | 3 +- nipyapi/security.py | 31 +-- nipyapi/system.py | 9 +- nipyapi/templates.py | 50 ++-- nipyapi/utils.py | 27 +- nipyapi/versioning.py | 101 ++------ pylintrc | 4 +- tests/conftest.py | 51 +++- tests/test_canvas.py | 71 +++++- tests/test_versioning.py | 4 +- tox.ini | 6 +- 13 files changed, 325 insertions(+), 271 deletions(-) diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 5d3e02cc..a163f0eb 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -14,7 +14,7 @@ "get_process_group", "list_all_process_groups", "delete_process_group", "schedule_process_group", "create_process_group", "list_all_processors", "list_all_processor_types", "get_processor_type", 'create_processor', - 'delete_processor', 'get_processor', 'schedule_processor', + 'delete_processor', 'get_processor', 'schedule_processor', 'get_funnel', 'update_processor', 'get_variable_registry', 'update_variable_registry', 'purge_connection', 'purge_process_group', 'schedule_components', 'get_bulletins', 'get_bulletin_board', 'list_invalid_processors', @@ -23,8 +23,8 @@ 'list_all_controllers', 'delete_controller', 'update_controller', 'schedule_controller', 'get_controller', 'list_all_controller_types', 'list_all_by_kind', 'list_all_input_ports', 'list_all_output_ports', - 'list_all_funnels', 'list_all_remote_process_groups', - 'get_remote_process_group', 'update_process_group' + 'list_all_funnels', 'list_all_remote_process_groups', 'delete_funnel', + 'get_remote_process_group', 'update_process_group', 'create_funnel' ] log = logging.getLogger(__name__) @@ -45,6 +45,8 @@ def 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 Args: pg_id (str): The Process Group UUID @@ -54,20 +56,18 @@ def recurse_flow(pg_id='root'): """ assert isinstance(pg_id, six.string_types), "pg_id should be a string" - def _walk_flow(node): - """This recursively extends the ProcessGroupEntity to contain the - ProcessGroupFlowEntity of each of it's child process groups. - So you can have the entire canvas in a single object. - """ - if isinstance(node, nipyapi.nifi.ProcessGroupFlowEntity): - for pg in node.process_group_flow.flow.process_groups: - pg.__setattr__( - 'nipyapi_extended', - recurse_flow(pg.id) - ) - return node - - return _walk_flow(get_flow(pg_id)) + out = get_flow(pg_id) + tasks = [(x.id, x) for x in out.process_group_flow.flow.process_groups] + while tasks: + this_pg_id, this_parent_obj = tasks.pop() + this_flow = get_flow(this_pg_id) + this_parent_obj.__setattr__( + 'nipyapi_extended', + this_flow + ) + tasks += [(x.id, x) for x in + this_flow.process_group_flow.flow.process_groups] + return out def get_flow(pg_id='root'): @@ -85,10 +85,8 @@ def get_flow(pg_id='root'): (ProcessGroupFlowEntity): The Process Group object """ assert isinstance(pg_id, six.string_types), "pg_id should be a string" - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.FlowApi().get_flow(pg_id) - except nipyapi.nifi.rest.ApiException as err: - raise ValueError(err.body) def get_process_group_status(pg_id='root', detail='names'): @@ -134,7 +132,7 @@ def get_process_group(identifier, identifier_type='name'): """ assert isinstance(identifier, six.string_types) assert identifier_type in ['name', 'id'] - try: + with nipyapi.utils.rest_exceptions(): if identifier_type == 'id': # assuming unique fetch of pg id # implementing separately to avoid recursing entire canvas @@ -142,8 +140,6 @@ def get_process_group(identifier, identifier_type='name'): else: obj = list_all_process_groups() out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) return out @@ -367,31 +363,11 @@ def delete_process_group(process_group, force=False, refresh=True): assert isinstance(process_group, nipyapi.nifi.ProcessGroupEntity) assert isinstance(force, bool) assert isinstance(refresh, bool) + pg_id = process_group.id if refresh or force: - target = nipyapi.nifi.ProcessGroupsApi().get_process_group( - process_group.id - ) + target = nipyapi.nifi.ProcessGroupsApi().get_process_group(pg_id) else: target = process_group - if force: - # Stop, drop, and roll. - purge_process_group(target, stop=True) - # Remove inbound connections - for con in list_all_connections(): - pg_id = process_group.id - if pg_id in [con.destination_group_id, con.source_group_id]: - delete_connection(con) - # Stop all Controller Services - for x in list_all_controllers(process_group.id): - delete_controller(x, True) - # Remove templates - for template in nipyapi.templates.list_all_templates(native=False): - if target.id == template.template.group_id: - nipyapi.templates.delete_template(template.id) - # have to refresh revision after changes - target = nipyapi.nifi.ProcessGroupsApi().get_process_group( - process_group.id - ) try: return nipyapi.nifi.ProcessGroupsApi().remove_process_group( id=target.id, @@ -399,6 +375,27 @@ def delete_process_group(process_group, force=False, refresh=True): client_id=target.revision.client_id ) except nipyapi.nifi.rest.ApiException as e: + if force: + # Stop, drop, and roll. + purge_process_group(target, stop=True) + # Remove inbound connections + for con in list_all_connections(): + if pg_id in [con.destination_group_id, con.source_group_id]: + delete_connection(con) + # Stop all Controller Services + for x in list_all_controllers(process_group.id): + delete_controller(x, True) + # Remove templates + for template in nipyapi.templates.list_all_templates(native=False): + if target.id == template.template.group_id: + nipyapi.templates.delete_template(template.id) + # have to refresh revision after changes + target = nipyapi.nifi.ProcessGroupsApi().get_process_group(pg_id) + return nipyapi.nifi.ProcessGroupsApi().remove_process_group( + id=target.id, + version=target.revision.version, + client_id=target.revision.client_id + ) raise ValueError(e.body) @@ -422,7 +419,7 @@ def create_process_group(parent_pg, new_pg_name, location, comment=''): assert isinstance(parent_pg, nipyapi.nifi.ProcessGroupEntity) assert isinstance(new_pg_name, six.string_types) assert isinstance(location, tuple) - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().create_process_group( id=parent_pg.id, body=nipyapi.nifi.ProcessGroupEntity( @@ -437,8 +434,6 @@ def create_process_group(parent_pg, new_pg_name, location, comment=''): ) ) ) - except nipyapi.nifi.rest.ApiException as e: - raise e def list_all_processor_types(): @@ -450,10 +445,8 @@ def list_all_processor_types(): processors list """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.FlowApi().get_processor_types() - except nipyapi.nifi.rest.ApiException as e: - raise e def get_processor_type(identifier, identifier_type='name'): @@ -469,10 +462,8 @@ def get_processor_type(identifier, identifier_type='name'): list(Objects) for multiple matches """ - try: + with nipyapi.utils.rest_exceptions(): obj = list_all_processor_types().processor_types - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) if obj: return nipyapi.utils.filter_obj(obj, identifier, identifier_type) return obj @@ -503,7 +494,7 @@ def create_processor(parent_pg, processor, location, name=None, config=None): target_config = nipyapi.nifi.ProcessorConfigDTO() else: target_config = config - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().create_processor( id=parent_pg.id, body=nipyapi.nifi.ProcessorEntity( @@ -519,8 +510,6 @@ def create_processor(parent_pg, processor, location, name=None, config=None): ) ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def get_processor(identifier, identifier_type='name'): @@ -539,14 +528,12 @@ def get_processor(identifier, identifier_type='name'): """ assert isinstance(identifier, six.string_types) assert identifier_type in ['name', 'id'] - try: + with nipyapi.utils.rest_exceptions(): if identifier_type == 'id': out = nipyapi.nifi.ProcessorsApi().get_processor(identifier) else: obj = list_all_processors() out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) return out @@ -585,13 +572,11 @@ def delete_processor(processor, refresh=True, force=False): # refresh state before trying delete target = get_processor(processor.id, 'id') assert isinstance(target, nipyapi.nifi.ProcessorEntity) - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessorsApi().delete_processor( id=target.id, version=target.revision.version ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def schedule_components(pg_id, scheduled, components=None): @@ -625,13 +610,11 @@ def schedule_components(pg_id, scheduled, components=None): ) if components: body.components = {i.id: i.revision for i in components} - try: + with nipyapi.utils.rest_exceptions(): result = nipyapi.nifi.FlowApi().schedule_components( id=pg_id, body=body ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) if result.state == target_state: return True return False @@ -720,7 +703,7 @@ def update_process_group(pg, update): """ assert isinstance(pg, nipyapi.nifi.ProcessGroupEntity) - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().update_process_group( id=pg.id, body=nipyapi.nifi.ProcessGroupEntity( @@ -732,8 +715,6 @@ def update_process_group(pg, update): revision=pg.revision ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def update_processor(processor, update): @@ -755,7 +736,7 @@ def update_processor(processor, update): raise ValueError( "update param is not an instance of nifi.ProcessorConfigDTO" ) - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessorsApi().update_processor( id=processor.id, body=nipyapi.nifi.ProcessorEntity( @@ -766,8 +747,6 @@ def update_processor(processor, update): revision=processor.revision, ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def get_variable_registry(process_group, ancestors=True): @@ -784,23 +763,22 @@ def get_variable_registry(process_group, ancestors=True): (VariableRegistryEntity): The Variable Registry """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().get_variable_registry( process_group.id, include_ancestor_groups=ancestors ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) -def update_variable_registry(process_group, update): +def update_variable_registry(process_group, update, refresh=True): """ Updates one or more key:value pairs in the variable registry Args: process_group (ProcessGroupEntity): The Process Group which has the Variable Registry to be updated - update (tuple[key, value]): The variables to write to the registry + update (list[tuple]): The variables to write to the registry + refresh (bool): Whether to refresh the object revision before updating Returns: (VariableRegistryEntity): The created or updated Variable Registry @@ -825,7 +803,9 @@ def update_variable_registry(process_group, update): ) ) for li in update ] - try: + with nipyapi.utils.rest_exceptions(): + if refresh: + process_group = get_process_group(process_group.id, 'id') return nipyapi.nifi.ProcessGroupsApi().update_variable_registry( id=process_group.id, body=nipyapi.nifi.VariableRegistryEntity( @@ -836,8 +816,6 @@ def update_variable_registry(process_group, update): ) ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def create_connection(source, target, relationships=None, name=None): @@ -858,7 +836,7 @@ def create_connection(source, target, relationships=None, name=None): # determine source and destination strings by class supplied source_type = nipyapi.utils.infer_object_label_from_class(source) target_type = nipyapi.utils.infer_object_label_from_class(target) - if source_type not in ['OUTPUT_PORT', 'INPUT_PORT']: + if source_type not in ['OUTPUT_PORT', 'INPUT_PORT', 'FUNNEL']: source_rels = [x.name for x in source.component.relationships] if relationships: assert all(i in source_rels for i in relationships), \ @@ -878,7 +856,7 @@ def create_connection(source, target, relationships=None, name=None): parent_id = parent_pg.component.parent_group_id else: parent_id = source.component.parent_group_id - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().create_connection( id=parent_id, body=nipyapi.nifi.ConnectionEntity( @@ -903,8 +881,6 @@ def create_connection(source, target, relationships=None, name=None): ) ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def delete_connection(connection, purge=False): @@ -922,13 +898,11 @@ def delete_connection(connection, purge=False): assert isinstance(connection, nipyapi.nifi.ConnectionEntity) if purge: purge_connection(connection.id) - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ConnectionsApi().delete_connection( id=connection.id, version=connection.revision.version ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def list_all_connections(pg_id='root', descendants=True): @@ -997,10 +971,8 @@ def _autumn_leaves(con_id_, drop_request_): ) return True - try: + with nipyapi.utils.rest_exceptions(): drop_req = nipyapi.nifi.FlowfileQueuesApi().create_drop_request(con_id) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) assert isinstance(drop_req, nipyapi.nifi.DropRequestEntity) return nipyapi.utils.wait_to_complete(_autumn_leaves, con_id, drop_req) @@ -1043,10 +1015,8 @@ def get_bulletins(): (ControllerBulletinsEntity): The native datatype containing a list of bulletins """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.FlowApi().get_bulletins() - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def get_bulletin_board(): @@ -1056,10 +1026,8 @@ def get_bulletin_board(): Returns: (BulletinBoardEntity): The native datatype BulletinBoard object """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.FlowApi().get_bulletin_board() - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def create_controller(parent_pg, controller, name=None): @@ -1080,7 +1048,7 @@ def create_controller(parent_pg, controller, name=None): assert isinstance(controller, nipyapi.nifi.DocumentedTypeDTO) assert isinstance(parent_pg, nipyapi.nifi.ProcessGroupEntity) assert name is None or isinstance(name, six.string_types) - try: + with nipyapi.utils.rest_exceptions(): out = nipyapi.nifi.ProcessGroupsApi().create_controller_service( id=parent_pg.id, body=nipyapi.nifi.ControllerServiceEntity( @@ -1098,8 +1066,6 @@ def create_controller(parent_pg, controller, name=None): name=name ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) return out @@ -1160,13 +1126,11 @@ def _del_cont(cont_id): if force: # Stop and refresh controller = schedule_controller(controller, False, True) - try: + with nipyapi.utils.rest_exceptions(): result = handle.remove_controller_service( id=controller.id, version=controller.revision.version ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) del_test = nipyapi.utils.wait_to_complete( _del_cont, controller.id, @@ -1394,7 +1358,7 @@ def create_port(pg_id, port_type, name, state, position=None): assert isinstance(position, tuple) handle = nipyapi.nifi.ProcessGroupsApi() port_generator = getattr(handle, 'create_' + port_type.lower()) - try: + with nipyapi.utils.rest_exceptions(): return port_generator( id=pg_id, body=nipyapi.nifi.PortEntity( @@ -1409,24 +1373,73 @@ def create_port(pg_id, port_type, name, state, position=None): ) ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def delete_port(port): """Deletes a given port from the canvas if possible""" assert isinstance(port, nipyapi.nifi.PortEntity) if 'INPUT' in port.port_type: - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.InputPortsApi().remove_input_port( id=port.id, version=port.revision.version) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) if 'OUTPUT' in port.port_type: - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.OutputPortsApi().remove_output_port( id=port.id, version=port.revision.version) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) + + +def get_funnel(funnel_id): + """Gets a given Funnel by ID""" + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.FunnelApi().get_funnel(funnel_id) + + +def create_funnel(pg_id, position=None): + """ + + Args: + pg_id (str): ID of the parent Process Group + position (tuple[int, int]): Position on canvas + + Returns: + (FunnelEntity) Created Funnel + """ + position = position if position else (400, 400) + assert isinstance(position, tuple) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.ProcessGroupsApi().create_funnel( + id=pg_id, + body=nipyapi.nifi.FunnelEntity( + position=nipyapi.nifi.PositionDTO( + x=float(position[0]), + y=float(position[1]) + ), + revision=nipyapi.nifi.RevisionDTO(version=0), + component=nipyapi.nifi.FunnelDTO( + parent_group_id=pg_id + ) + ) + ) + + +def delete_funnel(funnel, refresh=True): + """ + + Args: + funnel (FunnelEntity): The Funnel to delete + refresh (bool): Whether to refresh the object state + before execution + + Returns: + (FunnelEntity) Deleted FunnelEntity reference + """ + assert isinstance(funnel, nipyapi.nifi.FunnelEntity) + with nipyapi.utils.rest_exceptions(): + if refresh: + funnel = get_funnel(funnel.id) + return nipyapi.nifi.FunnelApi().remove_funnel( + id=funnel.id, + version=funnel.revision.version + ) diff --git a/nipyapi/demo/console.py b/nipyapi/demo/console.py index ec20bcb3..1d219f6c 100644 --- a/nipyapi/demo/console.py +++ b/nipyapi/demo/console.py @@ -60,8 +60,8 @@ location=(400.0, 400.0), name=_proc0, config=nipyapi.nifi.ProcessorConfigDTO( - scheduling_period='1s', - auto_terminated_relationships=['success'] + scheduling_period='5s', + auto_terminated_relationships=['failure'] ) ) diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index e07d7237..e7fb96fb 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -307,7 +307,8 @@ def reference_type(self, reference_type): :param reference_type: The reference_type of this ControllerServiceReferencingComponentDTO. :type: str """ - allowed_values = ["Processor", "ControllerService", "or ReportingTask"] + # allowed_values = ["Processor", "ControllerService", "or ReportingTask"] + allowed_values = ["Processor", "ControllerService", "ReportingTask"] if reference_type not in allowed_values: raise ValueError( "Invalid value for `reference_type` ({0}), must be one of {1}" diff --git a/nipyapi/security.py b/nipyapi/security.py index ed9ac8cc..2da6a49e 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -35,10 +35,8 @@ def list_service_users(service='nifi'): """Lists all users of a given service, takes a service name as a string""" assert service in _valid_services - try: + with nipyapi.utils.rest_exceptions(): out = getattr(nipyapi, service).TenantsApi().get_users() - except getattr(nipyapi, service).rest.ApiException as e: - raise ValueError(e.body) if service == 'nifi': return out.users return out @@ -131,8 +129,7 @@ def create_service_user(identity, service='nifi', strict=True): ) try: return getattr(nipyapi, service).TenantsApi().create_user(user_obj) - except ( - nipyapi.nifi.rest.ApiException, + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: if 'already exists' in e.body and not strict: return get_service_user(identity, service=service) @@ -181,8 +178,7 @@ def create_service_user_group(identity, service='nifi', return getattr(nipyapi, service).TenantsApi().create_user_group( user_group_obj ) - except ( - nipyapi.nifi.rest.ApiException, + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: if 'already exists' in e.body: if not strict: @@ -201,10 +197,8 @@ def list_service_user_groups(service='nifi'): """ assert service in _valid_services - try: + with nipyapi.utils.rest_exceptions(): out = getattr(nipyapi, service).TenantsApi().get_user_groups() - except getattr(nipyapi, service).rest.ApiException as e: - raise ValueError(e.body) if service == 'nifi': return out.user_groups return out @@ -572,13 +566,11 @@ def update_access_policy(policy, service='nifi'): nipyapi.registry.AccessPolicy if service == 'registry' else nipyapi.nifi.AccessPolicyEntity ), "Policy type {0} not vaid.".format(type(policy)) - try: + with nipyapi.utils.rest_exceptions(): return getattr(nipyapi, service).PoliciesApi().update_access_policy( id=policy.id if service == 'nifi' else policy.identifier, body=policy ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def get_access_policy_for_resource(resource, @@ -665,7 +657,7 @@ def create_access_policy(resource, action, r_id=None, service='nifi'): r = '/' + resource else: r = resource - try: + with nipyapi.utils.rest_exceptions(): if service == 'nifi': return nipyapi.nifi.PoliciesApi().create_access_policy( body=nipyapi.nifi.AccessPolicyEntity( @@ -683,9 +675,6 @@ def create_access_policy(resource, action, r_id=None, service='nifi'): resource=r ) ) - except nipyapi.nifi.rest.ApiException as f: - log.info("Policy creation unsuccessful, raising error") - raise ValueError(f.body) def set_service_ssl_context( @@ -748,7 +737,8 @@ def set_service_ssl_context( nipyapi.config.nifi_config.ssl_context = ssl_context -def bootstrap_security_policies(service, user_identity=None, group_identity=None): +def bootstrap_security_policies(service, user_identity=None, + group_identity=None): """ Creates a default security context within NiFi or Nifi-Registry @@ -788,14 +778,15 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None ) if nifi_user_identity is None: # I should not rely upon a try/catch there - # but it's the simplest way (I just hope it won't break the server :-) ) + # but it's the simplest way (I just hope it won't + # break the server :-) ) try: nipyapi.security.add_user_group_to_access_policy( user_group=group_identity, policy=ap, service='nifi' ) - except: + except: # noqa pass else: nipyapi.security.add_user_to_access_policy( diff --git a/nipyapi/system.py b/nipyapi/system.py index 5014a227..2eba118f 100644 --- a/nipyapi/system.py +++ b/nipyapi/system.py @@ -21,7 +21,8 @@ def get_system_diagnostics(): Returns (json): """ - return nipyapi.nifi.SystemDiagnosticsApi().get_system_diagnostics() + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.SystemDiagnosticsApi().get_system_diagnostics() def get_cluster(): @@ -31,7 +32,8 @@ def get_cluster(): Returns (json): """ - return nipyapi.nifi.ControllerApi().get_cluster() + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.ControllerApi().get_cluster() def get_node(nid): @@ -44,7 +46,8 @@ def get_node(nid): Returns: """ - return nipyapi.nifi.ControllerApi().get_node(nid) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.ControllerApi().get_node(nid) def get_nifi_version_info(): diff --git a/nipyapi/templates.py b/nipyapi/templates.py index 6eeec21b..032b90f2 100644 --- a/nipyapi/templates.py +++ b/nipyapi/templates.py @@ -62,10 +62,8 @@ def get_template(identifier, identifier_type='name'): """ assert isinstance(identifier, six.string_types) assert identifier_type in ['name', 'id'] - try: + with nipyapi.utils.rest_exceptions(): obj = nipyapi.templates.list_all_templates(native=False) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) if obj: return nipyapi.utils.filter_obj(obj, identifier, identifier_type) return obj @@ -88,7 +86,7 @@ def deploy_template(pg_id, template_id, loc_x=0, loc_y=0): template """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().instantiate_template( id=pg_id, body=nipyapi.nifi.InstantiateTemplateRequestEntity( @@ -97,8 +95,6 @@ def deploy_template(pg_id, template_id, loc_x=0, loc_y=0): template_id=template_id ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def create_pg_snippet(pg_id): @@ -122,9 +118,10 @@ def create_pg_snippet(pg_id): target_pg.component.parent_group_id } ) - snippet_resp = nipyapi.nifi.SnippetsApi().create_snippet( - new_snippet_req - ) + with nipyapi.utils.rest_exceptions(): + snippet_resp = nipyapi.nifi.SnippetsApi().create_snippet( + new_snippet_req + ) return snippet_resp @@ -142,15 +139,16 @@ def create_template(pg_id, name, desc=''): """ snippet = create_pg_snippet(pg_id) - new_template = nipyapi.nifi.CreateTemplateRequestEntity( - name=str(name), - description=str(desc), - snippet_id=snippet.snippet.id - ) - return nipyapi.nifi.ProcessGroupsApi().create_template( - id=snippet.snippet.parent_group_id, - body=new_template - ) + with nipyapi.utils.rest_exceptions(): + new_template = nipyapi.nifi.CreateTemplateRequestEntity( + name=str(name), + description=str(desc), + snippet_id=snippet.snippet.id + ) + return nipyapi.nifi.ProcessGroupsApi().create_template( + id=snippet.snippet.parent_group_id, + body=new_template + ) def delete_template(t_id): @@ -163,10 +161,8 @@ def delete_template(t_id): Returns: The updated Template object """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.TemplatesApi().remove_template(id=t_id) - except nipyapi.nifi.rest.ApiException as err: - raise ValueError(err.body) def upload_template(pg_id, template_file): @@ -182,11 +178,9 @@ def upload_template(pg_id, template_file): (TemplateEntity): The new Template object """ - try: + with nipyapi.utils.rest_exceptions(): this_pg = nipyapi.canvas.get_process_group(pg_id, 'id') assert isinstance(this_pg, nipyapi.nifi.ProcessGroupEntity) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) log.info("Called upload_template against endpoint %s with args %s", nipyapi.config.nifi_config.api_client.host, locals()) # Ensure we are receiving a valid file @@ -202,7 +196,7 @@ def upload_template(pg_id, template_file): .format(root_tag) ) t_name = tree.find('name').text - try: + with nipyapi.utils.rest_exceptions(): # For some reason identical code that produces the duplicate error # in later versions is going through OK for NiFi-1.1.2 # The error occurs as normal in Postman, so not sure what's going on @@ -217,8 +211,6 @@ def upload_template(pg_id, template_file): return nipyapi.templates.get_template( tree.find('name').text ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def export_template(t_id, output='string', file_path=None): @@ -261,10 +253,8 @@ def list_all_templates(native=True): Returns: (list[TemplateEntity]): A list of TemplateEntity's """ - try: + with nipyapi.utils.rest_exceptions(): templates = nipyapi.nifi.FlowApi().get_templates() - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) if not native: if templates: return templates.templates diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 4ae8470e..8df1931b 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -9,9 +9,12 @@ import logging import json import time -import six from copy import copy +from functools import reduce +import operator +from contextlib import contextmanager from packaging import version +import six import ruamel.yaml import docker from docker.errors import ImageNotFound @@ -156,8 +159,6 @@ def filter_obj(obj, value, key, greedy=True): Returns: None if 0 matches, list if > 1, single Object entity if ==1 """ - from functools import reduce - import operator # Using the object class name as a lookup as they are unique within the # NiFi DTOs if isinstance(obj, list) and not obj: @@ -195,8 +196,8 @@ def filter_obj(obj, value, key, greedy=True): ] else: out = [ - i for i in obj if value == - reduce(operator.getitem, key_lookup, i.to_dict()) + i for i in obj if + value == reduce(operator.getitem, key_lookup, i.to_dict()) ] # Manage our return contract if not out: @@ -262,14 +263,13 @@ def is_endpoint_up(endpoint_url): log.info("Got status code %s from endpoint, returning False", response.status_code) return False - except requests.ConnectionError or requests.exceptions.SSLError as e: + except (requests.ConnectionError, requests.exceptions.SSLError) as e: log.info("Got Error of type %s with details %s", type(e), str(e)) if 'SSLError' in str(type(e)): log.info("Got OpenSSL error, port is probably up but needs Cert") return True - else: - log.info("Got ConnectionError, returning False") - return False + log.info("Got ConnectionError, returning False") + return False def set_endpoint(endpoint_url, ssl=False, login=False): @@ -509,3 +509,12 @@ def bypass_slash_encoding(service, bypass): else: current_config.safe_chars_for_path_param = \ copy(nipyapi.config.default_safe_chars) + + +@contextmanager +def rest_exceptions(): + try: + yield + except (nipyapi.nifi.rest.ApiException, + nipyapi.registry.rest.ApiException) as e: + raise ValueError(e.body) diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 262dd87b..357adb4b 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -41,7 +41,7 @@ def create_registry_client(name, uri, description): assert isinstance(uri, six.string_types) and uri is not False assert isinstance(name, six.string_types) and name is not False assert isinstance(description, six.string_types) - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ControllerApi().create_registry_client( body={ 'component': { @@ -54,8 +54,6 @@ def create_registry_client(name, uri, description): } } ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def delete_registry_client(client, refresh=True): @@ -70,7 +68,7 @@ def delete_registry_client(client, refresh=True): (RegistryClientEntity): The updated client object """ assert isinstance(client, nipyapi.nifi.RegistryClientEntity) - try: + with nipyapi.utils.rest_exceptions(): if refresh: target = nipyapi.nifi.ControllerApi().get_registry_client( client.id @@ -81,8 +79,6 @@ def delete_registry_client(client, refresh=True): id=target.id, version=target.revision.version ) - except (nipyapi.nifi.rest.ApiException, AttributeError) as e: - raise ValueError(e) def list_registry_clients(): @@ -92,10 +88,8 @@ def list_registry_clients(): Returns: (list[RegistryClientEntity]) objects """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ControllerApi().get_registry_clients() - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def get_registry_client(identifier, identifier_type='name'): @@ -110,10 +104,8 @@ def get_registry_client(identifier, identifier_type='name'): None for no matches, Single Object for unique match, list(Objects) for multiple matches """ - try: + with nipyapi.utils.rest_exceptions(): obj = list_registry_clients().registries - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) return nipyapi.utils.filter_obj(obj, identifier, identifier_type) @@ -124,10 +116,8 @@ def list_registry_buckets(): Returns: (list[Bucket]) objects """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.registry.BucketsApi().get_buckets() - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) def create_registry_bucket(name): @@ -140,7 +130,7 @@ def create_registry_bucket(name): Returns: (Bucket): The new Bucket object """ - try: + with nipyapi.utils.rest_exceptions(): bucket = nipyapi.registry.BucketsApi().create_bucket( body={ 'name': name @@ -150,8 +140,6 @@ def create_registry_bucket(name): bucket.identifier, nipyapi.config.registry_config.api_client.host) return bucket - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) def delete_registry_bucket(bucket): @@ -184,10 +172,8 @@ def get_registry_bucket(identifier, identifier_type='name'): None for no matches, Single Object for unique match, list(Objects) for multiple matches """ - try: + with nipyapi.utils.rest_exceptions(): obj = list_registry_buckets() - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) return nipyapi.utils.filter_obj(obj, identifier, identifier_type) @@ -201,10 +187,8 @@ def list_flows_in_bucket(bucket_id): Returns: (list[VersionedFlow]) objects """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.registry.BucketFlowsApi().get_flows(bucket_id) - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) def get_flow_in_bucket(bucket_id, identifier, identifier_type='name'): @@ -220,10 +204,8 @@ def get_flow_in_bucket(bucket_id, identifier, identifier_type='name'): None for no matches, Single Object for unique match, list(Objects) for multiple matches """ - try: + with nipyapi.utils.rest_exceptions(): obj = list_flows_in_bucket(bucket_id) - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) return nipyapi.utils.filter_obj(obj, identifier, identifier_type) @@ -255,7 +237,7 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, target_pg = nipyapi.canvas.get_process_group(process_group.id, 'id') else: target_pg = process_group - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.VersionsApi().save_to_flow_registry( id=target_pg.id, body=nipyapi.nifi.StartVersionControlRequestEntity( @@ -270,8 +252,6 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, ) ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def stop_flow_ver(process_group, refresh=True): @@ -285,7 +265,7 @@ def stop_flow_ver(process_group, refresh=True): Returns: (VersionControlInformationEntity) """ - try: + with nipyapi.utils.rest_exceptions(): if refresh: target_pg = nipyapi.canvas.get_process_group( process_group.id, 'id' @@ -296,8 +276,6 @@ def stop_flow_ver(process_group, refresh=True): id=target_pg.id, version=target_pg.revision.version ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def revert_flow_ver(process_group): @@ -312,15 +290,14 @@ def revert_flow_ver(process_group): (VersionedFlowUpdateRequestEntity) """ # ToDo: Add handling for flows with live data - try: + assert isinstance(process_group, nipyapi.nifi.ProcessGroupEntity) + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.VersionsApi().initiate_revert_flow_version( id=process_group.id, body=nipyapi.nifi.VersionsApi().get_version_information( process_group.id ) ) - except (nipyapi.nifi.rest.ApiException, AttributeError) as e: - raise ValueError(e) def list_flow_versions(bucket_id, flow_id, registry_id=None, @@ -343,22 +320,18 @@ def list_flow_versions(bucket_id, flow_id, registry_id=None, """ assert service in ['nifi', 'registry'] if service == 'nifi': - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.FlowApi().get_versions( registry_id=registry_id, bucket_id=bucket_id, flow_id=flow_id ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) else: - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.registry.BucketFlowsApi().get_flow_versions( bucket_id=bucket_id, flow_id=flow_id ) - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) def update_flow_ver(process_group, target_version=None): @@ -392,7 +365,7 @@ def _running_update_flow_version(): "Flow Version Update did not complete successfully. " "Error text {0}".format(status.request.failure_reason) ) - try: + with nipyapi.utils.rest_exceptions(): vci = get_version_info(process_group) assert isinstance(vci, nipyapi.nifi.VersionControlInformationEntity) flow_vers = list_flow_versions( @@ -426,8 +399,6 @@ def _running_update_flow_version(): return nipyapi.nifi.VersionsApi().get_update_request( u_init.request.request_id ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) def get_latest_flow_ver(bucket_id, flow_id): @@ -441,12 +412,10 @@ def get_latest_flow_ver(bucket_id, flow_id): Returns: (VersionedFlowSnapshot) """ - try: + with nipyapi.utils.rest_exceptions(): return get_flow_version( bucket_id, flow_id, version=None ) - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) def get_version_info(process_group): @@ -459,12 +428,11 @@ def get_version_info(process_group): Returns: (VersionControlInformationEntity) """ - try: + assert isinstance(process_group, nipyapi.nifi.ProcessGroupEntity) + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.VersionsApi().get_version_information( process_group.id ) - except (nipyapi.nifi.rest.ApiException, AttributeError) as e: - raise ValueError(e) def create_flow(bucket_id, flow_name, flow_desc='', flow_type='Flow'): @@ -483,7 +451,7 @@ def create_flow(bucket_id, flow_name, flow_desc='', flow_type='Flow'): Returns: (VersionedFlow) """ - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.registry.BucketFlowsApi().create_flow( bucket_id=bucket_id, body=nipyapi.registry.VersionedFlow( @@ -494,8 +462,6 @@ def create_flow(bucket_id, flow_name, flow_desc='', flow_type='Flow'): version_count=0 ) ) - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) def create_flow_version(flow, flow_snapshot, refresh=True): @@ -521,7 +487,7 @@ def create_flow_version(flow, flow_snapshot, refresh=True): raise ValueError("flow_snapshot must be an instance of a " "registry.VersionedFlowSnapshot object, not an {0}" .format(type(flow_snapshot))) - try: + with nipyapi.utils.rest_exceptions(): if refresh: target_flow = get_flow_in_bucket( bucket_id=flow.bucket_identifier, @@ -553,8 +519,6 @@ def create_flow_version(flow, flow_snapshot, refresh=True): ), ) ) - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) def get_flow_version(bucket_id, flow_id, version=None, export=False): @@ -585,24 +549,20 @@ def get_flow_version(bucket_id, flow_id, version=None, export=False): ) assert isinstance(export, bool) if version: - try: + with nipyapi.utils.rest_exceptions(): out = nipyapi.registry.BucketFlowsApi().get_flow_version( bucket_id=bucket_id, flow_id=flow_id, version_number=str(version), # This str coercion is intended _preload_content=not export ) - except nipyapi.registry.rest.ApiException as e: - raise ValueError(e.body) else: - try: + with nipyapi.utils.rest_exceptions(): out = nipyapi.registry.BucketFlowsApi().get_latest_flow_version( bucket_id, flow_id, _preload_content=not export ) - except ValueError as e: - raise e if export: return out.data return out @@ -667,15 +627,13 @@ def import_flow_version(bucket_id, encoded_flow=None, file_path=None, # First, decode the flow snapshot contents dto = ('registry', 'VersionedFlowSnapshot') if file_path is None and encoded_flow is not None: - try: + with nipyapi.utils.rest_exceptions(): imported_flow = nipyapi.utils.load( encoded_flow, dto=dto ) - except ValueError as e: - raise e elif file_path is not None and encoded_flow is None: - try: + with nipyapi.utils.rest_exceptions(): file_in = nipyapi.utils.fs_read( file_path=file_path ) @@ -688,8 +646,6 @@ def import_flow_version(bucket_id, encoded_flow=None, file_path=None, imported_flow, nipyapi.registry.VersionedFlowSnapshot ) - except ValueError as e: - raise e else: raise ValueError("Either file_path must point to a file for import, or" " flow_snapshot must be an importable object, but" @@ -770,10 +726,9 @@ def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, "Registry Client [{3}]" .format(str(version), flow_id, bucket_id, reg_client_id) ) - else: - target_flow = target_flow[0].versioned_flow_snapshot_metadata + target_flow = target_flow[0].versioned_flow_snapshot_metadata # Issue deploy statement - try: + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().create_process_group( id=parent_id, body=nipyapi.nifi.ProcessGroupEntity( @@ -794,5 +749,3 @@ def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, ) ) ) - except nipyapi.nifi.rest.ApiException as e: - raise ValueError(e.body) diff --git a/pylintrc b/pylintrc index c3e2ec6e..46931638 100644 --- a/pylintrc +++ b/pylintrc @@ -355,10 +355,10 @@ valid-metaclass-classmethod-first-arg=mcs [DESIGN] # Maximum number of arguments for function / method -max-args=5 +max-args=8 # Maximum number of attributes for a class (see R0902). -max-attributes=7 +max-attributes=8 # Maximum number of boolean expressions in a if statement max-bool-expr=5 diff --git a/tests/conftest.py b/tests/conftest.py index 25f3db15..a45e8b5f 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -232,16 +232,11 @@ def remove_test_templates(): def remove_test_pgs(): - test_pgs = nipyapi.canvas.get_process_group(test_basename) - if test_pgs: - if not isinstance(test_pgs, list): - test_pgs = [test_pgs] - for this_test_pg in test_pgs: - nipyapi.canvas.delete_process_group( - this_test_pg, - force=True, - refresh=True - ) + _ = [ + nipyapi.canvas.delete_process_group(x, True, True) + for x in nipyapi.nifi.ProcessGroupsApi().get_process_groups('root').process_groups + if test_basename in x.status.name + ] def remove_test_processors(): @@ -252,6 +247,15 @@ def remove_test_processors(): ] +def remove_test_funnels(): + # Note that Funnels cannot be given labels so scoping is by PG only + remove_test_connections() + _ = [ + nipyapi.canvas.delete_funnel(x) + for x in nipyapi.canvas.list_all_funnels() + ] + + def remove_test_buckets(): _ = [nipyapi.versioning.delete_registry_bucket(li) for li in nipyapi.versioning.list_registry_buckets() if @@ -320,21 +324,25 @@ def cleanup_nifi(): log.info("Bulk cleanup called on host %s", nipyapi.config.nifi_config.host) remove_test_templates() + remove_test_pgs() remove_test_connections() remove_test_controllers() remove_test_processors() remove_test_ports() - remove_test_pgs() + remove_test_funnels() if test_security and 'https' in nipyapi.nifi.configuration.host: remove_test_service_user_groups('nifi') remove_test_service_users('nifi') def remove_test_connections(): + # Funnels don't have a name, have to go by type _ = [ nipyapi.canvas.delete_connection(x, True) for x in nipyapi.canvas.list_all_connections() - if test_basename in x.component.name + if x.destination_type == 'FUNNEL' + or x.source_type == 'FUNNEL' + or test_basename in x.component.name ] @@ -453,6 +461,25 @@ def generate(self, parent_pg=None, suffix='', kind=None, config=None): return Dummy() +@pytest.fixture(name='fix_funnel') +def fixture_funnel(request): + class Dummy: + def __init__(self): + pass + + def generate(self, parent_pg=None, position=(400, 400)): + if parent_pg is None: + target_pg = nipyapi.canvas.get_process_group( + nipyapi.canvas.get_root_pg_id(), 'id' + ) + else: + target_pg = parent_pg + return nipyapi.canvas.create_funnel(target_pg.id, position) + + request.addfinalizer(remove_test_funnels) + return Dummy() + + @pytest.fixture(name='fix_bucket', scope='function') def fixture_bucket(request): class Dummy: diff --git a/tests/test_canvas.py b/tests/test_canvas.py index 78e1458b..c7d80ba4 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -4,11 +4,11 @@ """Tests for `nipyapi` package.""" import pytest +import time from tests import conftest from nipyapi import canvas, nifi from nipyapi.nifi import ProcessGroupFlowEntity, ProcessGroupEntity from nipyapi.nifi import ProcessorTypesEntity, DocumentedTypeDTO -from nipyapi.nifi.rest import ApiException def test_get_root_pg_id(): @@ -80,7 +80,7 @@ def test_create_process_group(regress_nifi): assert s.component.parent_group_id == canvas.get_process_group(conftest.test_pg_name, "name").id assert isinstance(s, nifi.ProcessGroupEntity) - with pytest.raises(ApiException): + with pytest.raises(ValueError): parent_pg = canvas.get_process_group('NiFi Flow') parent_pg.id = 'invalid' _ = canvas.create_process_group( @@ -305,6 +305,27 @@ def test_update_variable_registry(fix_pg): conftest.test_variable_registry_entry ) assert isinstance(r1, nifi.VariableRegistryEntity) + with pytest.raises(ValueError, match='not the most up-to-date revision'): + _ = canvas.update_variable_registry( + test_pg, + conftest.test_variable_registry_entry, + refresh=False + ) + r2 = canvas.update_variable_registry( + test_pg, + conftest.test_variable_registry_entry, + refresh=True + ) + assert isinstance(r2, nifi.VariableRegistryEntity) + r3 = canvas.update_variable_registry( + test_pg, + [ + ('key1', 'value1'), + ('key2', 'value2') + ], + refresh=True + ) + assert isinstance(r3, nifi.VariableRegistryEntity) with pytest.raises(ValueError, match='param update is not a valid list of' ): @@ -355,6 +376,22 @@ def test_create_connection_processors(regress_nifi, fix_proc): _ = canvas.create_connection(f_p1, f_p2, ['not a connection']) +def test_create_connection_funnels(regress_nifi, fix_proc, fix_funnel): + f_p1 = fix_proc.generate() + f_f1 = fix_funnel.generate() + r1 = canvas.create_connection( + source=f_p1, + target=f_f1 + ) + assert isinstance(r1, nifi.ConnectionEntity) + f_p2 = fix_proc.generate() + r2 = canvas.create_connection( + source=f_f1, + target=f_p2 + ) + assert isinstance(r2, nifi.ConnectionEntity) + + def test_delete_connection(regress_nifi, fix_proc): f_p1 = fix_proc.generate() f_p2 = fix_proc.generate() @@ -583,3 +620,33 @@ def test_connect_output_ports(regress_nifi, fix_pg): name=conftest.test_basename ) assert isinstance(r1, nifi.ConnectionEntity) + + +def test_create_funnel(regress_nifi, fix_funnel): + f_f1 = fix_funnel.generate() + assert isinstance(f_f1, nifi.FunnelEntity) + + +def test_delete_funnel(regress_nifi, fix_funnel): + f_f1 = fix_funnel.generate() + assert isinstance(f_f1, nifi.FunnelEntity) + r1 = canvas.delete_funnel(f_f1) + assert r1.revision is None + with pytest.raises(ValueError): + _ = canvas.delete_funnel(f_f1) + + +@pytest.mark.skip +def test_client_recursion_limit(fix_pg, fix_funnel, target=450): + # https://github.com/Chaffelson/nipyapi/issues/147 + parent_pg = canvas.get_process_group('root') + for i in range(0, target): + parent_pg = fix_pg.generate(parent_pg, str(i)) + fix_funnel.generate(parent_pg) + start = time.time() + r1 = canvas.list_all_process_groups(canvas.get_root_pg_id()) + end = time.time() + assert len(r1) == target + 1 # +1 to allow for root PG + print("Len {0} Set {1}".format(len(r1), len(set([x.id for x in r1])))) + print("Elapsed r1: {0}".format((end - start))) + diff --git a/tests/test_versioning.py b/tests/test_versioning.py index 11cdbf4f..02a8b215 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -169,7 +169,7 @@ def test_revert_flow_ver(regress_flow_reg, fix_ver_flow): r1 = versioning.revert_flow_ver(fix_ver_flow.pg) assert isinstance(r1, nifi.VersionedFlowUpdateRequestEntity) # TODO: Add Tests for flows with data loss on reversion - with pytest.raises(ValueError): + with pytest.raises(AssertionError): _ = versioning.revert_flow_ver('NotAPg') @@ -221,7 +221,7 @@ def test_list_flow_versions(): def test_get_version_info(regress_flow_reg, fix_ver_flow): r1 = versioning.get_version_info(fix_ver_flow.pg) assert isinstance(r1, nifi.VersionControlInformationEntity) - with pytest.raises(ValueError): + with pytest.raises(AssertionError): _ = versioning.get_version_info('NotAPG') diff --git a/tox.ini b/tox.ini index b59a801f..0d5e9eb9 100644 --- a/tox.ini +++ b/tox.ini @@ -21,18 +21,18 @@ commands= [testenv:flake8] basepython=python3 deps=flake8>=3 -ignore=R0801 commands= - flake8 nipyapi + flake8 --ignore=R0801,R0912,R0902,R0903,R1718,R0913,C0302 nipyapi [coverage:run] include = # Include the NiPyApi code nipyapi/* omit = - # Do not include procedurally generated swagger clients + # Do not include procedurally generated swagger clients or demos nipyapi/nifi/* nipyapi/registry/* + nipyapi/demo/* [testenv] setenv = From ea6f7347ee2671c93028a66c9796e7b7d44c9d88 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Wed, 9 Oct 2019 17:06:03 +0100 Subject: [PATCH 09/40] Update NiFi-Registry client to 0.5.0 and correct minor issues (#159) * Updated NiFi-Registry Client to 0.5.0 Corrected security.bootstrap_policies for Registry Proxy commands Updated docker helper versions to latest * This time with all the new registry stuff added to git... --- docs/devnotes.rst | 2 +- nipyapi/registry/__init__.py | 45 +- nipyapi/registry/api_client.py | 6 +- nipyapi/registry/apis/__init__.py | 5 + nipyapi/registry/apis/access_api.py | 52 +- nipyapi/registry/apis/bucket_bundles_api.py | 260 + nipyapi/registry/apis/bucket_flows_api.py | 84 +- nipyapi/registry/apis/buckets_api.py | 44 +- nipyapi/registry/apis/bundles_api.py | 1393 ++++ nipyapi/registry/apis/config_api.py | 139 + .../registry/apis/extension_repository_api.py | 1508 ++++ nipyapi/registry/apis/extensions_api.py | 378 + nipyapi/registry/apis/flows_api.py | 52 +- nipyapi/registry/apis/items_api.py | 28 +- nipyapi/registry/apis/policies_api.py | 32 +- nipyapi/registry/apis/tenants_api.py | 84 +- nipyapi/registry/configuration.py | 6 +- nipyapi/registry/models/__init__.py | 40 +- nipyapi/registry/models/access_policy.py | 4 +- .../registry/models/access_policy_summary.py | 4 +- nipyapi/registry/models/allowable_value.py | 181 + nipyapi/registry/models/attribute.py | 153 + nipyapi/registry/models/batch_size.py | 4 +- nipyapi/registry/models/bucket.py | 68 +- nipyapi/registry/models/bucket_item.py | 12 +- nipyapi/registry/models/build_info.py | 293 + nipyapi/registry/models/bundle.py | 4 +- nipyapi/registry/models/bundle_info.py | 327 + nipyapi/registry/models/bundle_version.py | 264 + .../models/bundle_version_dependency.py | 181 + .../models/bundle_version_metadata.py | 469 ++ .../registry/models/component_difference.py | 4 +- .../models/component_difference_group.py | 4 +- .../registry/models/connectable_component.py | 4 +- .../registry/models/controller_service_api.py | 4 +- .../models/controller_service_definition.py | 209 + nipyapi/registry/models/current_user.py | 34 +- nipyapi/registry/models/deprecation_notice.py | 153 + nipyapi/registry/models/dynamic_property.py | 243 + .../registry/models/dynamic_relationship.py | 153 + nipyapi/registry/models/extension.py | 585 ++ nipyapi/registry/models/extension_bundle.py | 511 ++ .../models/extension_filter_params.py | 193 + nipyapi/registry/models/extension_metadata.py | 439 ++ .../models/extension_metadata_container.py | 181 + .../models/extension_repo_artifact.py | 209 + .../registry/models/extension_repo_bucket.py | 153 + .../registry/models/extension_repo_group.py | 181 + .../registry/models/extension_repo_version.py | 209 + .../models/extension_repo_version_summary.py | 293 + .../external_controller_service_reference.py | 153 + nipyapi/registry/models/fields.py | 4 +- nipyapi/registry/models/jaxb_link.py | 153 + nipyapi/registry/models/link.py | 279 - nipyapi/registry/models/model_property.py | 439 ++ nipyapi/registry/models/permissions.py | 4 +- nipyapi/registry/models/position.py | 4 +- .../registry/models/provided_service_api.py | 209 + .../registry/models/registry_configuration.py | 181 + nipyapi/registry/models/relationship.py | 181 + nipyapi/registry/models/resource.py | 4 +- .../registry/models/resource_permissions.py | 4 +- nipyapi/registry/models/restricted.py | 153 + nipyapi/registry/models/restriction.py | 153 + nipyapi/registry/models/stateful.py | 160 + .../models/system_resource_consideration.py | 153 + .../models/{uri_builder.py => tag_count.py} | 70 +- nipyapi/registry/models/tenant.py | 4 +- nipyapi/registry/models/user.py | 4 +- nipyapi/registry/models/user_group.py | 4 +- .../registry/models/versioned_connection.py | 102 +- .../models/versioned_controller_service.py | 4 +- nipyapi/registry/models/versioned_flow.py | 12 +- .../models/versioned_flow_coordinates.py | 4 +- .../models/versioned_flow_difference.py | 4 +- .../models/versioned_flow_snapshot.py | 90 +- .../versioned_flow_snapshot_metadata.py | 14 +- nipyapi/registry/models/versioned_funnel.py | 4 +- nipyapi/registry/models/versioned_label.py | 4 +- .../registry/models/versioned_parameter.py | 209 + .../models/versioned_parameter_context.py | 181 + nipyapi/registry/models/versioned_port.py | 68 +- .../models/versioned_process_group.py | 34 +- .../registry/models/versioned_processor.py | 40 +- .../models/versioned_property_descriptor.py | 4 +- .../models/versioned_remote_group_port.py | 40 +- .../models/versioned_remote_process_group.py | 12 +- nipyapi/registry/rest.py | 4 +- nipyapi/security.py | 3 +- .../client_gen/api_defs/registry-0.5.0.json | 6341 +++++++++++++++++ resources/client_gen/generate_api_client.sh | 2 +- resources/docker/latest/docker-compose.yml | 4 +- resources/docker/secure/docker-compose.yml | 4 +- resources/docker/tox-full/docker-compose.yml | 4 +- 94 files changed, 18792 insertions(+), 596 deletions(-) create mode 100644 nipyapi/registry/apis/bucket_bundles_api.py create mode 100644 nipyapi/registry/apis/bundles_api.py create mode 100644 nipyapi/registry/apis/config_api.py create mode 100644 nipyapi/registry/apis/extension_repository_api.py create mode 100644 nipyapi/registry/apis/extensions_api.py create mode 100644 nipyapi/registry/models/allowable_value.py create mode 100644 nipyapi/registry/models/attribute.py create mode 100644 nipyapi/registry/models/build_info.py create mode 100644 nipyapi/registry/models/bundle_info.py create mode 100644 nipyapi/registry/models/bundle_version.py create mode 100644 nipyapi/registry/models/bundle_version_dependency.py create mode 100644 nipyapi/registry/models/bundle_version_metadata.py create mode 100644 nipyapi/registry/models/controller_service_definition.py create mode 100644 nipyapi/registry/models/deprecation_notice.py create mode 100644 nipyapi/registry/models/dynamic_property.py create mode 100644 nipyapi/registry/models/dynamic_relationship.py create mode 100644 nipyapi/registry/models/extension.py create mode 100644 nipyapi/registry/models/extension_bundle.py create mode 100644 nipyapi/registry/models/extension_filter_params.py create mode 100644 nipyapi/registry/models/extension_metadata.py create mode 100644 nipyapi/registry/models/extension_metadata_container.py create mode 100644 nipyapi/registry/models/extension_repo_artifact.py create mode 100644 nipyapi/registry/models/extension_repo_bucket.py create mode 100644 nipyapi/registry/models/extension_repo_group.py create mode 100644 nipyapi/registry/models/extension_repo_version.py create mode 100644 nipyapi/registry/models/extension_repo_version_summary.py create mode 100644 nipyapi/registry/models/external_controller_service_reference.py create mode 100644 nipyapi/registry/models/jaxb_link.py delete mode 100644 nipyapi/registry/models/link.py create mode 100644 nipyapi/registry/models/model_property.py create mode 100644 nipyapi/registry/models/provided_service_api.py create mode 100644 nipyapi/registry/models/registry_configuration.py create mode 100644 nipyapi/registry/models/relationship.py create mode 100644 nipyapi/registry/models/restricted.py create mode 100644 nipyapi/registry/models/restriction.py create mode 100644 nipyapi/registry/models/stateful.py create mode 100644 nipyapi/registry/models/system_resource_consideration.py rename nipyapi/registry/models/{uri_builder.py => tag_count.py} (61%) create mode 100644 nipyapi/registry/models/versioned_parameter.py create mode 100644 nipyapi/registry/models/versioned_parameter_context.py create mode 100644 resources/client_gen/api_defs/registry-0.5.0.json diff --git a/docs/devnotes.rst b/docs/devnotes.rst index 327882b2..e6c5d5cb 100644 --- a/docs/devnotes.rst +++ b/docs/devnotes.rst @@ -75,7 +75,7 @@ NiFi Swagger Client NiFi Registry Swagger Client ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. build relevant version of NiFi Registry from source +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:: diff --git a/nipyapi/registry/__init__.py b/nipyapi/registry/__init__.py index 030f91c7..9933fcb9 100644 --- a/nipyapi/registry/__init__.py +++ b/nipyapi/registry/__init__.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -16,23 +16,53 @@ # import models into sdk package from .models.access_policy import AccessPolicy from .models.access_policy_summary import AccessPolicySummary +from .models.allowable_value import AllowableValue +from .models.attribute import Attribute from .models.batch_size import BatchSize from .models.bucket import Bucket from .models.bucket_item import BucketItem +from .models.build_info import BuildInfo from .models.bundle import Bundle +from .models.bundle_info import BundleInfo +from .models.bundle_version import BundleVersion +from .models.bundle_version_dependency import BundleVersionDependency +from .models.bundle_version_metadata import BundleVersionMetadata from .models.component_difference import ComponentDifference from .models.component_difference_group import ComponentDifferenceGroup from .models.connectable_component import ConnectableComponent from .models.controller_service_api import ControllerServiceAPI +from .models.controller_service_definition import ControllerServiceDefinition from .models.current_user import CurrentUser +from .models.deprecation_notice import DeprecationNotice +from .models.dynamic_property import DynamicProperty +from .models.dynamic_relationship import DynamicRelationship +from .models.extension import Extension +from .models.extension_bundle import ExtensionBundle +from .models.extension_filter_params import ExtensionFilterParams +from .models.extension_metadata import ExtensionMetadata +from .models.extension_metadata_container import ExtensionMetadataContainer +from .models.extension_repo_artifact import ExtensionRepoArtifact +from .models.extension_repo_bucket import ExtensionRepoBucket +from .models.extension_repo_group import ExtensionRepoGroup +from .models.extension_repo_version import ExtensionRepoVersion +from .models.extension_repo_version_summary import ExtensionRepoVersionSummary +from .models.external_controller_service_reference import ExternalControllerServiceReference from .models.fields import Fields -from .models.link import Link +from .models.jaxb_link import JaxbLink +from .models.model_property import ModelProperty from .models.permissions import Permissions from .models.position import Position +from .models.provided_service_api import ProvidedServiceAPI +from .models.registry_configuration import RegistryConfiguration +from .models.relationship import Relationship from .models.resource import Resource from .models.resource_permissions import ResourcePermissions +from .models.restricted import Restricted +from .models.restriction import Restriction +from .models.stateful import Stateful +from .models.system_resource_consideration import SystemResourceConsideration +from .models.tag_count import TagCount from .models.tenant import Tenant -from .models.uri_builder import UriBuilder from .models.user import User from .models.user_group import UserGroup from .models.versioned_connection import VersionedConnection @@ -44,6 +74,8 @@ from .models.versioned_flow_snapshot_metadata import VersionedFlowSnapshotMetadata from .models.versioned_funnel import VersionedFunnel from .models.versioned_label import VersionedLabel +from .models.versioned_parameter import VersionedParameter +from .models.versioned_parameter_context import VersionedParameterContext from .models.versioned_port import VersionedPort from .models.versioned_process_group import VersionedProcessGroup from .models.versioned_processor import VersionedProcessor @@ -53,8 +85,13 @@ # import apis into sdk package from .apis.access_api import AccessApi +from .apis.bucket_bundles_api import BucketBundlesApi from .apis.bucket_flows_api import BucketFlowsApi from .apis.buckets_api import BucketsApi +from .apis.bundles_api import BundlesApi +from .apis.config_api import ConfigApi +from .apis.extension_repository_api import ExtensionRepositoryApi +from .apis.extensions_api import ExtensionsApi from .apis.flows_api import FlowsApi from .apis.items_api import ItemsApi from .apis.policies_api import PoliciesApi diff --git a/nipyapi/registry/api_client.py b/nipyapi/registry/api_client.py index 29aee5ba..82194326 100644 --- a/nipyapi/registry/api_client.py +++ b/nipyapi/registry/api_client.py @@ -1,10 +1,10 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -628,6 +628,6 @@ def __deserialize_model(self, data, klass): value = data[klass.attribute_map[attr]] kwargs[attr] = self.__deserialize(value, attr_type) - instance = klass(**kwargs) + instance = klass(**kwargs) return instance diff --git a/nipyapi/registry/apis/__init__.py b/nipyapi/registry/apis/__init__.py index 00a6d627..51ee613d 100644 --- a/nipyapi/registry/apis/__init__.py +++ b/nipyapi/registry/apis/__init__.py @@ -2,8 +2,13 @@ # import apis into api package from .access_api import AccessApi +from .bucket_bundles_api import BucketBundlesApi from .bucket_flows_api import BucketFlowsApi from .buckets_api import BucketsApi +from .bundles_api import BundlesApi +from .config_api import ConfigApi +from .extension_repository_api import ExtensionRepositoryApi +from .extensions_api import ExtensionsApi from .flows_api import FlowsApi from .items_api import ItemsApi from .policies_api import PoliciesApi diff --git a/nipyapi/registry/apis/access_api.py b/nipyapi/registry/apis/access_api.py index e4b09986..a4306e41 100644 --- a/nipyapi/registry/apis/access_api.py +++ b/nipyapi/registry/apis/access_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + 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: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,8 +42,8 @@ def __init__(self, api_client=None): def create_access_token_by_trying_all_providers(self, **kwargs): """ - 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 '. + 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -67,8 +67,8 @@ def create_access_token_by_trying_all_providers(self, **kwargs): def create_access_token_by_trying_all_providers_with_http_info(self, **kwargs): """ - 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 '. + 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -140,8 +140,8 @@ def create_access_token_by_trying_all_providers_with_http_info(self, **kwargs): def create_access_token_using_basic_auth_credentials(self, **kwargs): """ - 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 ', where is the base64 encoded value of ':'. 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 '. + 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 ', where is the base64 encoded value of ':'. 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -165,8 +165,8 @@ def create_access_token_using_basic_auth_credentials(self, **kwargs): def create_access_token_using_basic_auth_credentials_with_http_info(self, **kwargs): """ - 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 ', where is the base64 encoded value of ':'. 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 '. + 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 ', where is the base64 encoded value of ':'. 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -238,8 +238,8 @@ def create_access_token_using_basic_auth_credentials_with_http_info(self, **kwar def create_access_token_using_identity_provider_credentials(self, **kwargs): """ - 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 '. + 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -263,8 +263,8 @@ def create_access_token_using_identity_provider_credentials(self, **kwargs): def create_access_token_using_identity_provider_credentials_with_http_info(self, **kwargs): """ - 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 '. + 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -336,8 +336,8 @@ def create_access_token_using_identity_provider_credentials_with_http_info(self, def create_access_token_using_kerberos_ticket(self, **kwargs): """ - 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 '. + 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -361,8 +361,8 @@ def create_access_token_using_kerberos_ticket(self, **kwargs): def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs): """ - 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 '. + 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 '. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -434,8 +434,8 @@ def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs): def get_access_status(self, **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. @@ -459,8 +459,8 @@ def get_access_status(self, **kwargs): def get_access_status_with_http_info(self, **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. @@ -532,8 +532,8 @@ def get_access_status_with_http_info(self, **kwargs): def get_identity_provider_usage_instructions(self, **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. @@ -557,8 +557,8 @@ def get_identity_provider_usage_instructions(self, **kwargs): def get_identity_provider_usage_instructions_with_http_info(self, **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. @@ -630,8 +630,8 @@ def get_identity_provider_usage_instructions_with_http_info(self, **kwargs): def test_identity_provider_recognizes_credentials_format(self, **kwargs): """ - 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'. + 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. @@ -655,8 +655,8 @@ def test_identity_provider_recognizes_credentials_format(self, **kwargs): def test_identity_provider_recognizes_credentials_format_with_http_info(self, **kwargs): """ - 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'. + 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. diff --git a/nipyapi/registry/apis/bucket_bundles_api.py b/nipyapi/registry/apis/bucket_bundles_api.py new file mode 100644 index 00000000..fc01e64a --- /dev/null +++ b/nipyapi/registry/apis/bucket_bundles_api.py @@ -0,0 +1,260 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class BucketBundlesApi(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 + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def create_extension_bundle_version(self, bucket_id, bundle_type, **kwargs): + """ + Create extension bundle version + Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. 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_extension_bundle_version(bucket_id, bundle_type, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_id: The bucket identifier (required) + :param str bundle_type: The type of the bundle (required) + :return: BundleVersion + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, **kwargs) + else: + (data) = self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, **kwargs) + return data + + def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, **kwargs): + """ + Create extension bundle version + Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. 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_extension_bundle_version_with_http_info(bucket_id, bundle_type, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_id: The bucket identifier (required) + :param str bundle_type: The type of the bundle (required) + :return: BundleVersion + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_id', 'bundle_type'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_extension_bundle_version" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_id' is set + if ('bucket_id' not in params) or (params['bucket_id'] is None): + raise ValueError("Missing the required parameter `bucket_id` when calling `create_extension_bundle_version`") + # verify the required parameter 'bundle_type' is set + if ('bundle_type' not in params) or (params['bundle_type'] is None): + raise ValueError("Missing the required parameter `bundle_type` when calling `create_extension_bundle_version`") + + + collection_formats = {} + + path_params = {} + if 'bucket_id' in params: + path_params['bucketId'] = params['bucket_id'] + if 'bundle_type' in params: + path_params['bundleType'] = params['bundle_type'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['multipart/form-data']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/buckets/{bucketId}/bundles/{bundleType}', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BundleVersion', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_bundles(self, bucket_id, **kwargs): + """ + Get extension bundles by bucket + 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_extension_bundles(bucket_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_id: The bucket identifier (required) + :return: list[ExtensionBundle] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_bundles_with_http_info(bucket_id, **kwargs) + else: + (data) = self.get_extension_bundles_with_http_info(bucket_id, **kwargs) + return data + + def get_extension_bundles_with_http_info(self, bucket_id, **kwargs): + """ + Get extension bundles by bucket + 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_extension_bundles_with_http_info(bucket_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_id: The bucket identifier (required) + :return: list[ExtensionBundle] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_bundles" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_id' is set + if ('bucket_id' not in params) or (params['bucket_id'] is None): + raise ValueError("Missing the required parameter `bucket_id` when calling `get_extension_bundles`") + + + collection_formats = {} + + path_params = {} + if 'bucket_id' in params: + path_params['bucketId'] = params['bucket_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/buckets/{bucketId}/bundles', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionBundle]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/nipyapi/registry/apis/bucket_flows_api.py b/nipyapi/registry/apis/bucket_flows_api.py index 00c11978..e2717fd4 100644 --- a/nipyapi/registry/apis/bucket_flows_api.py +++ b/nipyapi/registry/apis/bucket_flows_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + 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: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,8 +42,8 @@ def __init__(self, api_client=None): def create_flow(self, bucket_id, body, **kwargs): """ - Creates a flow - The flow id is created by the server and populated in the returned entity. + 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. @@ -69,8 +69,8 @@ def create_flow(self, bucket_id, body, **kwargs): def create_flow_with_http_info(self, bucket_id, body, **kwargs): """ - Creates a flow - The flow id is created by the server and populated in the returned entity. + 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. @@ -155,8 +155,8 @@ def create_flow_with_http_info(self, bucket_id, body, **kwargs): def create_flow_version(self, bucket_id, flow_id, body, **kwargs): """ - 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. + 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. @@ -183,8 +183,8 @@ def create_flow_version(self, bucket_id, flow_id, body, **kwargs): def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs): """ - 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. + 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. @@ -275,8 +275,8 @@ def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs) def delete_flow(self, 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. @@ -302,8 +302,8 @@ def delete_flow(self, bucket_id, flow_id, **kwargs): def delete_flow_with_http_info(self, 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. @@ -388,8 +388,8 @@ def delete_flow_with_http_info(self, bucket_id, flow_id, **kwargs): def get_flow(self, bucket_id, flow_id, **kwargs): """ - Gets a flow - + 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. @@ -415,8 +415,8 @@ def get_flow(self, bucket_id, flow_id, **kwargs): def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Gets a flow - + 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. @@ -501,8 +501,8 @@ def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): def get_flow_diff(self, bucket_id, flow_id, version_a, version_b, **kwargs): """ - Returns a list of differences between 2 versions of a flow - + 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. @@ -530,8 +530,8 @@ def get_flow_diff(self, bucket_id, flow_id, version_a, version_b, **kwargs): def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, **kwargs): """ - Returns a list of differences between 2 versions of a flow - + 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. @@ -632,8 +632,8 @@ def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, def get_flow_version(self, bucket_id, flow_id, version_number, **kwargs): """ - Gets the given version of a flow - + 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. @@ -660,8 +660,8 @@ def get_flow_version(self, bucket_id, flow_id, version_number, **kwargs): def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, **kwargs): """ - Gets the given version of a flow - + 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. @@ -754,8 +754,8 @@ def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, ** def get_flow_versions(self, 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. @@ -781,8 +781,8 @@ def get_flow_versions(self, bucket_id, flow_id, **kwargs): def get_flow_versions_with_http_info(self, 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. @@ -867,8 +867,8 @@ def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs): def get_flows(self, bucket_id, **kwargs): """ - Gets all flows in the given bucket - + 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. @@ -893,8 +893,8 @@ def get_flows(self, bucket_id, **kwargs): def get_flows_with_http_info(self, bucket_id, **kwargs): """ - Gets all flows in the given bucket - + 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. @@ -973,8 +973,8 @@ def get_flows_with_http_info(self, bucket_id, **kwargs): def get_latest_flow_version(self, bucket_id, flow_id, **kwargs): """ - Get the latest version of a flow - + 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. @@ -1000,8 +1000,8 @@ def get_latest_flow_version(self, bucket_id, flow_id, **kwargs): def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Get the latest version of a flow - + 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. @@ -1086,8 +1086,8 @@ def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): def get_latest_flow_version_metadata(self, bucket_id, flow_id, **kwargs): """ - Get the metadata for the latest version of a flow - + 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. @@ -1113,8 +1113,8 @@ def get_latest_flow_version_metadata(self, bucket_id, flow_id, **kwargs): def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, **kwargs): """ - Get the metadata for the latest version of a flow - + 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. @@ -1199,8 +1199,8 @@ def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, ** def update_flow(self, bucket_id, flow_id, body, **kwargs): """ - Updates a flow - + 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. @@ -1227,8 +1227,8 @@ def update_flow(self, bucket_id, flow_id, body, **kwargs): def update_flow_with_http_info(self, bucket_id, flow_id, body, **kwargs): """ - Updates a flow - + 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. diff --git a/nipyapi/registry/apis/buckets_api.py b/nipyapi/registry/apis/buckets_api.py index 9ceb569b..edf9325a 100644 --- a/nipyapi/registry/apis/buckets_api.py +++ b/nipyapi/registry/apis/buckets_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + 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: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,7 +42,7 @@ def __init__(self, api_client=None): def create_bucket(self, body, **kwargs): """ - Creates a bucket + Create bucket This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -68,7 +68,7 @@ def create_bucket(self, body, **kwargs): def create_bucket_with_http_info(self, body, **kwargs): """ - Creates a bucket + Create bucket This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -148,8 +148,8 @@ def create_bucket_with_http_info(self, body, **kwargs): def delete_bucket(self, bucket_id, **kwargs): """ - Deletes a bucket along with all objects stored in the bucket - + 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. @@ -174,8 +174,8 @@ def delete_bucket(self, bucket_id, **kwargs): def delete_bucket_with_http_info(self, bucket_id, **kwargs): """ - Deletes a bucket along with all objects stored in the bucket - + 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. @@ -254,8 +254,8 @@ def delete_bucket_with_http_info(self, bucket_id, **kwargs): def get_available_bucket_fields(self, **kwargs): """ - Retrieves field names for searching or sorting on buckets. - + 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. @@ -279,8 +279,8 @@ def get_available_bucket_fields(self, **kwargs): def get_available_bucket_fields_with_http_info(self, **kwargs): """ - Retrieves field names for searching or sorting on buckets. - + 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. @@ -352,8 +352,8 @@ def get_available_bucket_fields_with_http_info(self, **kwargs): def get_bucket(self, bucket_id, **kwargs): """ - Gets a bucket - + 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. @@ -378,8 +378,8 @@ def get_bucket(self, bucket_id, **kwargs): def get_bucket_with_http_info(self, bucket_id, **kwargs): """ - Gets a bucket - + 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. @@ -458,7 +458,7 @@ def get_bucket_with_http_info(self, bucket_id, **kwargs): def get_buckets(self, **kwargs): """ - Gets all buckets + 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 @@ -483,7 +483,7 @@ def get_buckets(self, **kwargs): def get_buckets_with_http_info(self, **kwargs): """ - Gets all buckets + 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 @@ -556,8 +556,8 @@ def get_buckets_with_http_info(self, **kwargs): def update_bucket(self, bucket_id, body, **kwargs): """ - Updates a bucket - + 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. @@ -583,8 +583,8 @@ def update_bucket(self, bucket_id, body, **kwargs): def update_bucket_with_http_info(self, bucket_id, body, **kwargs): """ - Updates a bucket - + 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. diff --git a/nipyapi/registry/apis/bundles_api.py b/nipyapi/registry/apis/bundles_api.py new file mode 100644 index 00000000..8c241619 --- /dev/null +++ b/nipyapi/registry/apis/bundles_api.py @@ -0,0 +1,1393 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class BundlesApi(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 + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def get_bundle_version_extension_additional_details_docs(self, bundle_id, version, name, **kwargs): + """ + Get bundle version extension docs details + Gets the additional details documentation for the given extension in the given extension bundle version. 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_bundle_version_extension_additional_details_docs(bundle_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, **kwargs) + else: + (data) = self.get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, **kwargs) + return data + + def get_bundle_version_extension_additional_details_docs_with_http_info(self, bundle_id, version, name, **kwargs): + """ + Get bundle version extension docs details + Gets the additional details documentation for the given extension in the given extension bundle version. 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_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id', 'version', 'name'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_bundle_version_extension_additional_details_docs" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extension_additional_details_docs`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extension_additional_details_docs`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_bundle_version_extension_additional_details_docs`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['text/html']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_bundle_version_extension_docs(self, bundle_id, version, name, **kwargs): + """ + Get bundle version extension docs + Gets the documentation for the given extension in the given extension bundle version. 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_bundle_version_extension_docs(bundle_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, **kwargs) + else: + (data) = self.get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, **kwargs) + return data + + def get_bundle_version_extension_docs_with_http_info(self, bundle_id, version, name, **kwargs): + """ + Get bundle version extension docs + Gets the documentation for the given extension in the given extension bundle version. 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_bundle_version_extension_docs_with_http_info(bundle_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id', 'version', 'name'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_bundle_version_extension_docs" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `get_bundle_version_extension_docs`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_bundle_version_extension_docs`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_bundle_version_extension_docs`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['text/html']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_bundle_versions(self, **kwargs): + """ + Get all bundle versions + Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. 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_bundle_versions(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'. + :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'. + :param str version: Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'. + :return: list[BundleVersionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_bundle_versions_with_http_info(**kwargs) + else: + (data) = self.get_bundle_versions_with_http_info(**kwargs) + return data + + def get_bundle_versions_with_http_info(self, **kwargs): + """ + Get all bundle versions + Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. 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_bundle_versions_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'. + :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'. + :param str version: Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'. + :return: list[BundleVersionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['group_id', 'artifact_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_bundle_versions" % key + ) + params[key] = val + del params['kwargs'] + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'group_id' in params: + query_params.append(('groupId', params['group_id'])) + if 'artifact_id' in params: + query_params.append(('artifactId', params['artifact_id'])) + if 'version' in params: + query_params.append(('version', params['version'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/versions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[BundleVersionMetadata]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_bundles(self, **kwargs): + """ + Get all bundles + Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results 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. 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_bundles(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'. + :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'. + :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'. + :return: list[ExtensionBundle] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_bundles_with_http_info(**kwargs) + else: + (data) = self.get_bundles_with_http_info(**kwargs) + return data + + def get_bundles_with_http_info(self, **kwargs): + """ + Get all bundles + Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results 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. 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_bundles_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'. + :param str group_id: Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'. + :param str artifact_id: Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'. + :return: list[ExtensionBundle] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_bundles" % key + ) + params[key] = val + del params['kwargs'] + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'bucket_name' in params: + query_params.append(('bucketName', params['bucket_name'])) + if 'group_id' in params: + query_params.append(('groupId', params['group_id'])) + if 'artifact_id' in params: + query_params.append(('artifactId', params['artifact_id'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionBundle]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_delete_bundle_version(self, bundle_id, version, **kwargs): + """ + Delete bundle version + Deletes the given extension bundle version and it's associated binary content. 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.global_delete_bundle_version(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: BundleVersion + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_delete_bundle_version_with_http_info(bundle_id, version, **kwargs) + else: + (data) = self.global_delete_bundle_version_with_http_info(bundle_id, version, **kwargs) + return data + + def global_delete_bundle_version_with_http_info(self, bundle_id, version, **kwargs): + """ + Delete bundle version + Deletes the given extension bundle version and it's associated binary content. 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.global_delete_bundle_version_with_http_info(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: BundleVersion + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_delete_bundle_version" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_delete_bundle_version`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `global_delete_bundle_version`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BundleVersion', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_delete_extension_bundle(self, bundle_id, **kwargs): + """ + Delete bundle + Deletes the given extension bundle and all of it's versions. 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.global_delete_extension_bundle(bundle_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :return: ExtensionBundle + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_delete_extension_bundle_with_http_info(bundle_id, **kwargs) + else: + (data) = self.global_delete_extension_bundle_with_http_info(bundle_id, **kwargs) + return data + + def global_delete_extension_bundle_with_http_info(self, bundle_id, **kwargs): + """ + Delete bundle + Deletes the given extension bundle and all of it's versions. 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.global_delete_extension_bundle_with_http_info(bundle_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :return: ExtensionBundle + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_delete_extension_bundle" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_delete_extension_bundle`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ExtensionBundle', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_get_bundle_version(self, bundle_id, version, **kwargs): + """ + Get bundle version + Gets the descriptor for the given version of the given extension bundle. 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.global_get_bundle_version(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: BundleVersion + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_get_bundle_version_with_http_info(bundle_id, version, **kwargs) + else: + (data) = self.global_get_bundle_version_with_http_info(bundle_id, version, **kwargs) + return data + + def global_get_bundle_version_with_http_info(self, bundle_id, version, **kwargs): + """ + Get bundle version + Gets the descriptor for the given version of the given extension bundle. 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.global_get_bundle_version_with_http_info(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: BundleVersion + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_get_bundle_version" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='BundleVersion', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_get_bundle_version_content(self, bundle_id, version, **kwargs): + """ + Get bundle version content + Gets the binary content for the given version of the given extension bundle. 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.global_get_bundle_version_content(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: list[str] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_get_bundle_version_content_with_http_info(bundle_id, version, **kwargs) + else: + (data) = self.global_get_bundle_version_content_with_http_info(bundle_id, version, **kwargs) + return data + + def global_get_bundle_version_content_with_http_info(self, bundle_id, version, **kwargs): + """ + Get bundle version content + Gets the binary content for the given version of the given extension bundle. 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.global_get_bundle_version_content_with_http_info(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: list[str] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_get_bundle_version_content" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version_content`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version_content`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/octet-stream']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/content', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[str]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_get_bundle_version_extension(self, bundle_id, version, name, **kwargs): + """ + Get bundle version extension + Gets the metadata about the extension with the given name in the given extension bundle version. 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.global_get_bundle_version_extension(bundle_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :param str name: The fully qualified name of the extension (required) + :return: list[Extension] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_get_bundle_version_extension_with_http_info(bundle_id, version, name, **kwargs) + else: + (data) = self.global_get_bundle_version_extension_with_http_info(bundle_id, version, name, **kwargs) + return data + + def global_get_bundle_version_extension_with_http_info(self, bundle_id, version, name, **kwargs): + """ + Get bundle version extension + Gets the metadata about the extension with the given name in the given extension bundle version. 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.global_get_bundle_version_extension_with_http_info(bundle_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :param str name: The fully qualified name of the extension (required) + :return: list[Extension] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id', 'version', 'name'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_get_bundle_version_extension" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version_extension`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version_extension`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `global_get_bundle_version_extension`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[Extension]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_get_bundle_version_extensions(self, bundle_id, version, **kwargs): + """ + Get bundle version extensions + Gets the metadata about the extensions in the given extension bundle version. 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.global_get_bundle_version_extensions(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: list[ExtensionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_get_bundle_version_extensions_with_http_info(bundle_id, version, **kwargs) + else: + (data) = self.global_get_bundle_version_extensions_with_http_info(bundle_id, version, **kwargs) + return data + + def global_get_bundle_version_extensions_with_http_info(self, bundle_id, version, **kwargs): + """ + Get bundle version extensions + Gets the metadata about the extensions in the given extension bundle version. 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.global_get_bundle_version_extensions_with_http_info(bundle_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :param str version: The version of the bundle (required) + :return: list[ExtensionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_get_bundle_version_extensions" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_version_extensions`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `global_get_bundle_version_extensions`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionMetadata]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_get_bundle_versions(self, bundle_id, **kwargs): + """ + Get bundle versions + Gets the metadata for the versions of the given extension bundle. 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.global_get_bundle_versions(bundle_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :return: list[BundleVersionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_get_bundle_versions_with_http_info(bundle_id, **kwargs) + else: + (data) = self.global_get_bundle_versions_with_http_info(bundle_id, **kwargs) + return data + + def global_get_bundle_versions_with_http_info(self, bundle_id, **kwargs): + """ + Get bundle versions + Gets the metadata for the versions of the given extension bundle. 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.global_get_bundle_versions_with_http_info(bundle_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :return: list[BundleVersionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_get_bundle_versions" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_bundle_versions`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}/versions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[BundleVersionMetadata]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def global_get_extension_bundle(self, bundle_id, **kwargs): + """ + Get bundle + Gets the metadata about an extension bundle. 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.global_get_extension_bundle(bundle_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :return: ExtensionBundle + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.global_get_extension_bundle_with_http_info(bundle_id, **kwargs) + else: + (data) = self.global_get_extension_bundle_with_http_info(bundle_id, **kwargs) + return data + + def global_get_extension_bundle_with_http_info(self, bundle_id, **kwargs): + """ + Get bundle + Gets the metadata about an extension bundle. 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.global_get_extension_bundle_with_http_info(bundle_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_id: The extension bundle identifier (required) + :return: ExtensionBundle + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method global_get_extension_bundle" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bundle_id' is set + if ('bundle_id' not in params) or (params['bundle_id'] is None): + raise ValueError("Missing the required parameter `bundle_id` when calling `global_get_extension_bundle`") + + + collection_formats = {} + + path_params = {} + if 'bundle_id' in params: + path_params['bundleId'] = params['bundle_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/bundles/{bundleId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ExtensionBundle', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/nipyapi/registry/apis/config_api.py b/nipyapi/registry/apis/config_api.py new file mode 100644 index 00000000..49c234b8 --- /dev/null +++ b/nipyapi/registry/apis/config_api.py @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class ConfigApi(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 + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def get_configuration(self, **kwargs): + """ + Get configration + Gets the NiFi Registry configurations. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_configuration(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: RegistryConfiguration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_configuration_with_http_info(**kwargs) + else: + (data) = self.get_configuration_with_http_info(**kwargs) + return data + + def get_configuration_with_http_info(self, **kwargs): + """ + Get configration + Gets the NiFi Registry configurations. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_configuration_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: RegistryConfiguration + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/config', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='RegistryConfiguration', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/nipyapi/registry/apis/extension_repository_api.py b/nipyapi/registry/apis/extension_repository_api.py new file mode 100644 index 00000000..980b71c3 --- /dev/null +++ b/nipyapi/registry/apis/extension_repository_api.py @@ -0,0 +1,1508 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class ExtensionRepositoryApi(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 + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def get_extension_repo_artifacts(self, bucket_name, group_id, **kwargs): + """ + Get extension repo artifacts + Gets the artifacts in the extension repository in the given bucket and 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_extension_repo_artifacts(bucket_name, group_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group id (required) + :return: list[ExtensionRepoArtifact] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_artifacts_with_http_info(bucket_name, group_id, **kwargs) + else: + (data) = self.get_extension_repo_artifacts_with_http_info(bucket_name, group_id, **kwargs) + return data + + def get_extension_repo_artifacts_with_http_info(self, bucket_name, group_id, **kwargs): + """ + Get extension repo artifacts + Gets the artifacts in the extension repository in the given bucket and 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_extension_repo_artifacts_with_http_info(bucket_name, group_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group id (required) + :return: list[ExtensionRepoArtifact] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_artifacts" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_artifacts`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_artifacts`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionRepoArtifact]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_buckets(self, **kwargs): + """ + Get extension repo buckets + Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. 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_extension_repo_buckets(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: list[ExtensionRepoBucket] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_buckets_with_http_info(**kwargs) + else: + (data) = self.get_extension_repo_buckets_with_http_info(**kwargs) + return data + + def get_extension_repo_buckets_with_http_info(self, **kwargs): + """ + Get extension repo buckets + Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. 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_extension_repo_buckets_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: list[ExtensionRepoBucket] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_buckets" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionRepoBucket]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_groups(self, bucket_name, **kwargs): + """ + Get extension repo groups + Gets the groups in the extension repository in the given bucket. 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_extension_repo_groups(bucket_name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :return: list[ExtensionRepoGroup] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_groups_with_http_info(bucket_name, **kwargs) + else: + (data) = self.get_extension_repo_groups_with_http_info(bucket_name, **kwargs) + return data + + def get_extension_repo_groups_with_http_info(self, bucket_name, **kwargs): + """ + Get extension repo groups + Gets the groups in the extension repository in the given bucket. 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_extension_repo_groups_with_http_info(bucket_name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :return: list[ExtensionRepoGroup] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_groups" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_groups`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionRepoGroup]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_version(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo version + Gets information about the version in the given bucket, group, and artifact. 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_extension_repo_version(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: ExtensionRepoVersion + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_version_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + else: + (data) = self.get_extension_repo_version_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + return data + + def get_extension_repo_version_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo version + Gets information about the version in the given bucket, group, and artifact. 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_extension_repo_version_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: ExtensionRepoVersion + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_version" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_version`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_version`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_version`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ExtensionRepoVersion', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_version_content(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo version content + Gets the binary content of the bundle with the given bucket, group, artifact, and version. 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_extension_repo_version_content(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: list[str] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_version_content_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + else: + (data) = self.get_extension_repo_version_content_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + return data + + def get_extension_repo_version_content_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo version content + Gets the binary content of the bundle with the given bucket, group, artifact, and version. 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_extension_repo_version_content_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: list[str] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_version_content" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_version_content`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_version_content`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_version_content`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_content`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/octet-stream']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[str]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_version_extension(self, bucket_name, group_id, artifact_id, version, name, **kwargs): + """ + Get extension repo extension + Gets information about the extension with the given name in the given bucket, group, artifact, and version. 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_extension_repo_version_extension(bucket_name, group_id, artifact_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :param str name: The fully qualified name of the extension (required) + :return: Extension + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_version_extension_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs) + else: + (data) = self.get_extension_repo_version_extension_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs) + return data + + def get_extension_repo_version_extension_with_http_info(self, bucket_name, group_id, artifact_id, version, name, **kwargs): + """ + Get extension repo extension + Gets information about the extension with the given name in the given bucket, group, artifact, and version. 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_extension_repo_version_extension_with_http_info(bucket_name, group_id, artifact_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :param str name: The fully qualified name of the extension (required) + :return: Extension + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id', 'version', 'name'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_version_extension" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_version_extension`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_version_extension`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_version_extension`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_extension`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_extension_repo_version_extension`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Extension', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_version_extension_additional_details_docs(self, bucket_name, group_id, artifact_id, version, name, **kwargs): + """ + Get extension repo extension details + Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. 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_extension_repo_version_extension_additional_details_docs(bucket_name, group_id, artifact_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_version_extension_additional_details_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs) + else: + (data) = self.get_extension_repo_version_extension_additional_details_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs) + return data + + def get_extension_repo_version_extension_additional_details_docs_with_http_info(self, bucket_name, group_id, artifact_id, version, name, **kwargs): + """ + Get extension repo extension details + Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. 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_extension_repo_version_extension_additional_details_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id', 'version', 'name'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_version_extension_additional_details_docs" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_version_extension_additional_details_docs`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_version_extension_additional_details_docs`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_version_extension_additional_details_docs`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_extension_additional_details_docs`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_extension_repo_version_extension_additional_details_docs`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['text/html']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_version_extension_docs(self, bucket_name, group_id, artifact_id, version, name, **kwargs): + """ + Get extension repo extension docs + Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. 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_extension_repo_version_extension_docs(bucket_name, group_id, artifact_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_version_extension_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs) + else: + (data) = self.get_extension_repo_version_extension_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs) + return data + + def get_extension_repo_version_extension_docs_with_http_info(self, bucket_name, group_id, artifact_id, version, name, **kwargs): + """ + Get extension repo extension docs + Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. 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_extension_repo_version_extension_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :param str name: The fully qualified name of the extension (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id', 'version', 'name'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_version_extension_docs" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_version_extension_docs`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_version_extension_docs`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_version_extension_docs`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_extension_docs`") + # verify the required parameter 'name' is set + if ('name' not in params) or (params['name'] is None): + raise ValueError("Missing the required parameter `name` when calling `get_extension_repo_version_extension_docs`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + if 'name' in params: + path_params['name'] = params['name'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['text/html']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_version_extensions(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo extensions + Gets information about the extensions in the given bucket, group, artifact, and version. 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_extension_repo_version_extensions(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: list[ExtensionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_version_extensions_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + else: + (data) = self.get_extension_repo_version_extensions_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + return data + + def get_extension_repo_version_extensions_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo extensions + Gets information about the extensions in the given bucket, group, artifact, and version. 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_extension_repo_version_extensions_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: list[ExtensionMetadata] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_version_extensions" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_version_extensions`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_version_extensions`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_version_extensions`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_extensions`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionMetadata]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_version_sha256(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo version checksum + Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version. 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_extension_repo_version_sha256(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_version_sha256_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + else: + (data) = self.get_extension_repo_version_sha256_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs) + return data + + def get_extension_repo_version_sha256_with_http_info(self, bucket_name, group_id, artifact_id, version, **kwargs): + """ + Get extension repo version checksum + Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version. 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_extension_repo_version_sha256_with_http_info(bucket_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_version_sha256" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_version_sha256`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_version_sha256`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_version_sha256`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extension_repo_version_sha256`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['text/plain']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extension_repo_versions(self, bucket_name, group_id, artifact_id, **kwargs): + """ + Get extension repo versions + Gets the versions in the extension repository for the given bucket, group, and artifact. 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_extension_repo_versions(bucket_name, group_id, artifact_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :return: list[ExtensionRepoVersionSummary] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extension_repo_versions_with_http_info(bucket_name, group_id, artifact_id, **kwargs) + else: + (data) = self.get_extension_repo_versions_with_http_info(bucket_name, group_id, artifact_id, **kwargs) + return data + + def get_extension_repo_versions_with_http_info(self, bucket_name, group_id, artifact_id, **kwargs): + """ + Get extension repo versions + Gets the versions in the extension repository for the given bucket, group, and artifact. 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_extension_repo_versions_with_http_info(bucket_name, group_id, artifact_id, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bucket_name: The bucket name (required) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :return: list[ExtensionRepoVersionSummary] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bucket_name', 'group_id', 'artifact_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extension_repo_versions" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'bucket_name' is set + if ('bucket_name' not in params) or (params['bucket_name'] is None): + raise ValueError("Missing the required parameter `bucket_name` when calling `get_extension_repo_versions`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extension_repo_versions`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extension_repo_versions`") + + + collection_formats = {} + + path_params = {} + if 'bucket_name' in params: + path_params['bucketName'] = params['bucket_name'] + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[ExtensionRepoVersionSummary]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_global_extension_repo_version_sha256(self, group_id, artifact_id, version, **kwargs): + """ + Get global extension repo version checksum + Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. 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_global_extension_repo_version_sha256(group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_global_extension_repo_version_sha256_with_http_info(group_id, artifact_id, version, **kwargs) + else: + (data) = self.get_global_extension_repo_version_sha256_with_http_info(group_id, artifact_id, version, **kwargs) + return data + + def get_global_extension_repo_version_sha256_with_http_info(self, group_id, artifact_id, version, **kwargs): + """ + Get global extension repo version checksum + Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. 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_global_extension_repo_version_sha256_with_http_info(group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str group_id: The group identifier (required) + :param str artifact_id: The artifact identifier (required) + :param str version: The version (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['group_id', 'artifact_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_global_extension_repo_version_sha256" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_global_extension_repo_version_sha256`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_global_extension_repo_version_sha256`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_global_extension_repo_version_sha256`") + + + collection_formats = {} + + path_params = {} + if 'group_id' in params: + path_params['groupId'] = params['group_id'] + if 'artifact_id' in params: + path_params['artifactId'] = params['artifact_id'] + if 'version' in params: + path_params['version'] = params['version'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['text/plain']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extension-repository/{groupId}/{artifactId}/{version}/sha256', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/nipyapi/registry/apis/extensions_api.py b/nipyapi/registry/apis/extensions_api.py new file mode 100644 index 00000000..dd7446fb --- /dev/null +++ b/nipyapi/registry/apis/extensions_api.py @@ -0,0 +1,378 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class ExtensionsApi(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 + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def get_extensions(self, **kwargs): + """ + Get all extensions + Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. 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_extensions(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_type: The type of bundles to return + :param str extension_type: The type of extensions to return + :param list[str] tag: The tags to filter on, will be used in an OR statement + :return: ExtensionMetadataContainer + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extensions_with_http_info(**kwargs) + else: + (data) = self.get_extensions_with_http_info(**kwargs) + return data + + def get_extensions_with_http_info(self, **kwargs): + """ + Get all extensions + Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. 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_extensions_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str bundle_type: The type of bundles to return + :param str extension_type: The type of extensions to return + :param list[str] tag: The tags to filter on, will be used in an OR statement + :return: ExtensionMetadataContainer + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['bundle_type', 'extension_type', 'tag'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extensions" % key + ) + params[key] = val + del params['kwargs'] + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'bundle_type' in params: + query_params.append(('bundleType', params['bundle_type'])) + if 'extension_type' in params: + query_params.append(('extensionType', params['extension_type'])) + if 'tag' in params: + query_params.append(('tag', params['tag'])) + collection_formats['tag'] = 'multi' + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extensions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ExtensionMetadataContainer', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_extensions_providing_service_api(self, class_name, group_id, artifact_id, version, **kwargs): + """ + Get extensions providing service API + Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. 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_extensions_providing_service_api(class_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str class_name: The name of the service API class (required) + :param str group_id: The groupId of the bundle containing the service API class (required) + :param str artifact_id: The artifactId of the bundle containing the service API class (required) + :param str version: The version of the bundle containing the service API class (required) + :return: ExtensionMetadataContainer + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_extensions_providing_service_api_with_http_info(class_name, group_id, artifact_id, version, **kwargs) + else: + (data) = self.get_extensions_providing_service_api_with_http_info(class_name, group_id, artifact_id, version, **kwargs) + return data + + def get_extensions_providing_service_api_with_http_info(self, class_name, group_id, artifact_id, version, **kwargs): + """ + Get extensions providing service API + Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. 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_extensions_providing_service_api_with_http_info(class_name, group_id, artifact_id, version, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str class_name: The name of the service API class (required) + :param str group_id: The groupId of the bundle containing the service API class (required) + :param str artifact_id: The artifactId of the bundle containing the service API class (required) + :param str version: The version of the bundle containing the service API class (required) + :return: ExtensionMetadataContainer + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['class_name', 'group_id', 'artifact_id', 'version'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_extensions_providing_service_api" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'class_name' is set + if ('class_name' not in params) or (params['class_name'] is None): + raise ValueError("Missing the required parameter `class_name` when calling `get_extensions_providing_service_api`") + # verify the required parameter 'group_id' is set + if ('group_id' not in params) or (params['group_id'] is None): + raise ValueError("Missing the required parameter `group_id` when calling `get_extensions_providing_service_api`") + # verify the required parameter 'artifact_id' is set + if ('artifact_id' not in params) or (params['artifact_id'] is None): + raise ValueError("Missing the required parameter `artifact_id` when calling `get_extensions_providing_service_api`") + # verify the required parameter 'version' is set + if ('version' not in params) or (params['version'] is None): + raise ValueError("Missing the required parameter `version` when calling `get_extensions_providing_service_api`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'class_name' in params: + query_params.append(('className', params['class_name'])) + if 'group_id' in params: + query_params.append(('groupId', params['group_id'])) + if 'artifact_id' in params: + query_params.append(('artifactId', params['artifact_id'])) + if 'version' in params: + query_params.append(('version', params['version'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extensions/provided-service-api', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ExtensionMetadataContainer', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_tags(self, **kwargs): + """ + Get extension tags + Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag. 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_tags(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: list[TagCount] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_tags_with_http_info(**kwargs) + else: + (data) = self.get_tags_with_http_info(**kwargs) + return data + + def get_tags_with_http_info(self, **kwargs): + """ + Get extension tags + Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag. 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_tags_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: list[TagCount] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_tags" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'Authorization'] + + return self.api_client.call_api('/extensions/tags', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[TagCount]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/nipyapi/registry/apis/flows_api.py b/nipyapi/registry/apis/flows_api.py index 6f4a2feb..d35abe90 100644 --- a/nipyapi/registry/apis/flows_api.py +++ b/nipyapi/registry/apis/flows_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + 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: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,8 +42,8 @@ def __init__(self, api_client=None): def get_available_flow_fields(self, **kwargs): """ - Retrieves the available field names that can be used for searching or sorting on flows. - + 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. @@ -67,8 +67,8 @@ def get_available_flow_fields(self, **kwargs): def get_available_flow_fields_with_http_info(self, **kwargs): """ - Retrieves the available field names that can be used for searching or sorting on flows. - + 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. @@ -140,8 +140,8 @@ def get_available_flow_fields_with_http_info(self, **kwargs): def global_get_flow(self, flow_id, **kwargs): """ - Gets a flow - + 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. @@ -166,8 +166,8 @@ def global_get_flow(self, flow_id, **kwargs): def global_get_flow_with_http_info(self, flow_id, **kwargs): """ - Gets a flow - + 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. @@ -246,8 +246,8 @@ def global_get_flow_with_http_info(self, flow_id, **kwargs): def global_get_flow_version(self, flow_id, version_number, **kwargs): """ - Gets the given version of a flow - + 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. @@ -273,8 +273,8 @@ def global_get_flow_version(self, flow_id, version_number, **kwargs): def global_get_flow_version_with_http_info(self, flow_id, version_number, **kwargs): """ - Gets the given version of a flow - + 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. @@ -361,8 +361,8 @@ def global_get_flow_version_with_http_info(self, flow_id, version_number, **kwar def global_get_flow_versions(self, flow_id, **kwargs): """ - Gets summary information for all versions of a flow. Versions are ordered newest->oldest. - + 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. @@ -387,8 +387,8 @@ def global_get_flow_versions(self, flow_id, **kwargs): def global_get_flow_versions_with_http_info(self, flow_id, **kwargs): """ - Gets summary information for all versions of a flow. Versions are ordered newest->oldest. - + 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. @@ -467,8 +467,8 @@ def global_get_flow_versions_with_http_info(self, flow_id, **kwargs): def global_get_latest_flow_version(self, flow_id, **kwargs): """ - Get the latest version of a flow - + 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. @@ -493,8 +493,8 @@ def global_get_latest_flow_version(self, flow_id, **kwargs): def global_get_latest_flow_version_with_http_info(self, flow_id, **kwargs): """ - Get the latest version of a flow - + 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. @@ -573,8 +573,8 @@ def global_get_latest_flow_version_with_http_info(self, flow_id, **kwargs): def global_get_latest_flow_version_metadata(self, flow_id, **kwargs): """ - Get the metadata for the latest version of a flow - + 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. @@ -599,8 +599,8 @@ def global_get_latest_flow_version_metadata(self, flow_id, **kwargs): def global_get_latest_flow_version_metadata_with_http_info(self, flow_id, **kwargs): """ - Get the metadata for the latest version of a flow - + 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. diff --git a/nipyapi/registry/apis/items_api.py b/nipyapi/registry/apis/items_api.py index 2b87df53..6ce7e063 100644 --- a/nipyapi/registry/apis/items_api.py +++ b/nipyapi/registry/apis/items_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + 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: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,8 +42,8 @@ def __init__(self, api_client=None): def get_available_bucket_item_fields(self, **kwargs): """ - Retrieves the available field names for searching or sorting on bucket items. - + 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. @@ -67,8 +67,8 @@ def get_available_bucket_item_fields(self, **kwargs): def get_available_bucket_item_fields_with_http_info(self, **kwargs): """ - Retrieves the available field names for searching or sorting on bucket items. - + 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. @@ -140,8 +140,8 @@ def get_available_bucket_item_fields_with_http_info(self, **kwargs): def get_items(self, **kwargs): """ - 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. + 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. @@ -165,8 +165,8 @@ def get_items(self, **kwargs): def get_items_with_http_info(self, **kwargs): """ - 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. + 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. @@ -238,8 +238,8 @@ def get_items_with_http_info(self, **kwargs): def get_items_in_bucket(self, bucket_id, **kwargs): """ - Gets items of the given bucket - + 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. @@ -264,8 +264,8 @@ def get_items_in_bucket(self, bucket_id, **kwargs): def get_items_in_bucket_with_http_info(self, bucket_id, **kwargs): """ - Gets items of the given bucket - + 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. diff --git a/nipyapi/registry/apis/policies_api.py b/nipyapi/registry/apis/policies_api.py index 7ebf1e11..57af7df8 100644 --- a/nipyapi/registry/apis/policies_api.py +++ b/nipyapi/registry/apis/policies_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + 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: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,7 +42,7 @@ def __init__(self, api_client=None): def create_access_policy(self, body, **kwargs): """ - Creates an access policy + Create access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -68,7 +68,7 @@ def create_access_policy(self, body, **kwargs): def create_access_policy_with_http_info(self, body, **kwargs): """ - Creates an access policy + Create access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -148,7 +148,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): def get_access_policies(self, **kwargs): """ - Gets all access policies + Get all access policies This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -173,7 +173,7 @@ def get_access_policies(self, **kwargs): def get_access_policies_with_http_info(self, **kwargs): """ - Gets all access policies + Get all access policies This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -246,7 +246,7 @@ def get_access_policies_with_http_info(self, **kwargs): def get_access_policy(self, id, **kwargs): """ - Gets an access policy + Get access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -272,7 +272,7 @@ def get_access_policy(self, id, **kwargs): def get_access_policy_with_http_info(self, id, **kwargs): """ - Gets an access policy + Get access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -352,8 +352,8 @@ def get_access_policy_with_http_info(self, id, **kwargs): def get_access_policy_for_resource(self, 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. @@ -379,8 +379,8 @@ def get_access_policy_for_resource(self, action, resource, **kwargs): def get_access_policy_for_resource_with_http_info(self, 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. @@ -467,8 +467,8 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar def get_resources(self, **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. @@ -492,8 +492,8 @@ def get_resources(self, **kwargs): def get_resources_with_http_info(self, **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. @@ -565,7 +565,7 @@ def get_resources_with_http_info(self, **kwargs): def remove_access_policy(self, id, **kwargs): """ - Deletes an access policy + Delete access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -591,7 +591,7 @@ def remove_access_policy(self, id, **kwargs): def remove_access_policy_with_http_info(self, id, **kwargs): """ - Deletes an access policy + Delete access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -671,7 +671,7 @@ def remove_access_policy_with_http_info(self, id, **kwargs): def update_access_policy(self, id, body, **kwargs): """ - Updates a access policy + Update access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function @@ -698,7 +698,7 @@ def update_access_policy(self, id, body, **kwargs): def update_access_policy_with_http_info(self, id, body, **kwargs): """ - Updates a access policy + Update access policy This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function diff --git a/nipyapi/registry/apis/tenants_api.py b/nipyapi/registry/apis/tenants_api.py index efb0e48e..dcab2d29 100644 --- a/nipyapi/registry/apis/tenants_api.py +++ b/nipyapi/registry/apis/tenants_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,8 +42,8 @@ def __init__(self, api_client=None): def create_user(self, body, **kwargs): """ - Creates a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -68,8 +68,8 @@ def create_user(self, body, **kwargs): def create_user_with_http_info(self, body, **kwargs): """ - Creates a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -148,8 +148,8 @@ def create_user_with_http_info(self, body, **kwargs): def create_user_group(self, body, **kwargs): """ - Creates a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -174,8 +174,8 @@ def create_user_group(self, body, **kwargs): def create_user_group_with_http_info(self, body, **kwargs): """ - Creates a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -254,8 +254,8 @@ def create_user_group_with_http_info(self, body, **kwargs): def get_user(self, id, **kwargs): """ - Gets a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -280,8 +280,8 @@ def get_user(self, id, **kwargs): def get_user_with_http_info(self, id, **kwargs): """ - Gets a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -360,8 +360,8 @@ def get_user_with_http_info(self, id, **kwargs): def get_user_group(self, id, **kwargs): """ - Gets a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -386,8 +386,8 @@ def get_user_group(self, id, **kwargs): def get_user_group_with_http_info(self, id, **kwargs): """ - Gets a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -466,8 +466,8 @@ def get_user_group_with_http_info(self, id, **kwargs): def get_user_groups(self, **kwargs): """ - Gets all user groups - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -491,8 +491,8 @@ def get_user_groups(self, **kwargs): def get_user_groups_with_http_info(self, **kwargs): """ - Gets all user groups - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -564,8 +564,8 @@ def get_user_groups_with_http_info(self, **kwargs): def get_users(self, **kwargs): """ - Gets all users - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -589,8 +589,8 @@ def get_users(self, **kwargs): def get_users_with_http_info(self, **kwargs): """ - Gets all users - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -662,8 +662,8 @@ def get_users_with_http_info(self, **kwargs): def remove_user(self, id, **kwargs): """ - Deletes a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -688,8 +688,8 @@ def remove_user(self, id, **kwargs): def remove_user_with_http_info(self, id, **kwargs): """ - Deletes a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -768,8 +768,8 @@ def remove_user_with_http_info(self, id, **kwargs): def remove_user_group(self, id, **kwargs): """ - Deletes a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -794,8 +794,8 @@ def remove_user_group(self, id, **kwargs): def remove_user_group_with_http_info(self, id, **kwargs): """ - Deletes a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -874,8 +874,8 @@ def remove_user_group_with_http_info(self, id, **kwargs): def update_user(self, id, body, **kwargs): """ - Updates a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -901,8 +901,8 @@ def update_user(self, id, body, **kwargs): def update_user_with_http_info(self, id, body, **kwargs): """ - Updates a user - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -987,8 +987,8 @@ def update_user_with_http_info(self, id, body, **kwargs): def update_user_group(self, id, body, **kwargs): """ - Updates a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. @@ -1014,8 +1014,8 @@ def update_user_group(self, id, body, **kwargs): def update_user_group_with_http_info(self, id, body, **kwargs): """ - Updates a user group - Note: This endpoint is subject to change as NiFi Registry and its REST API evolve. + 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. diff --git a/nipyapi/registry/configuration.py b/nipyapi/registry/configuration.py index 16f7f322..543f5921 100644 --- a/nipyapi/registry/configuration.py +++ b/nipyapi/registry/configuration.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -242,6 +242,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 0.2.0\n"\ + "Version of the API: 0.5.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/registry/models/__init__.py b/nipyapi/registry/models/__init__.py index e246d09e..3352313d 100644 --- a/nipyapi/registry/models/__init__.py +++ b/nipyapi/registry/models/__init__.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -16,23 +16,53 @@ # import models into model package from .access_policy import AccessPolicy from .access_policy_summary import AccessPolicySummary +from .allowable_value import AllowableValue +from .attribute import Attribute from .batch_size import BatchSize from .bucket import Bucket from .bucket_item import BucketItem +from .build_info import BuildInfo from .bundle import Bundle +from .bundle_info import BundleInfo +from .bundle_version import BundleVersion +from .bundle_version_dependency import BundleVersionDependency +from .bundle_version_metadata import BundleVersionMetadata from .component_difference import ComponentDifference from .component_difference_group import ComponentDifferenceGroup from .connectable_component import ConnectableComponent from .controller_service_api import ControllerServiceAPI +from .controller_service_definition import ControllerServiceDefinition from .current_user import CurrentUser +from .deprecation_notice import DeprecationNotice +from .dynamic_property import DynamicProperty +from .dynamic_relationship import DynamicRelationship +from .extension import Extension +from .extension_bundle import ExtensionBundle +from .extension_filter_params import ExtensionFilterParams +from .extension_metadata import ExtensionMetadata +from .extension_metadata_container import ExtensionMetadataContainer +from .extension_repo_artifact import ExtensionRepoArtifact +from .extension_repo_bucket import ExtensionRepoBucket +from .extension_repo_group import ExtensionRepoGroup +from .extension_repo_version import ExtensionRepoVersion +from .extension_repo_version_summary import ExtensionRepoVersionSummary +from .external_controller_service_reference import ExternalControllerServiceReference from .fields import Fields -from .link import Link +from .jaxb_link import JaxbLink +from .model_property import ModelProperty from .permissions import Permissions from .position import Position +from .provided_service_api import ProvidedServiceAPI +from .registry_configuration import RegistryConfiguration +from .relationship import Relationship from .resource import Resource from .resource_permissions import ResourcePermissions +from .restricted import Restricted +from .restriction import Restriction +from .stateful import Stateful +from .system_resource_consideration import SystemResourceConsideration +from .tag_count import TagCount from .tenant import Tenant -from .uri_builder import UriBuilder from .user import User from .user_group import UserGroup from .versioned_connection import VersionedConnection @@ -44,6 +74,8 @@ from .versioned_flow_snapshot_metadata import VersionedFlowSnapshotMetadata from .versioned_funnel import VersionedFunnel from .versioned_label import VersionedLabel +from .versioned_parameter import VersionedParameter +from .versioned_parameter_context import VersionedParameterContext from .versioned_port import VersionedPort from .versioned_process_group import VersionedProcessGroup from .versioned_processor import VersionedProcessor diff --git a/nipyapi/registry/models/access_policy.py b/nipyapi/registry/models/access_policy.py index a8348831..7cf47e3d 100644 --- a/nipyapi/registry/models/access_policy.py +++ b/nipyapi/registry/models/access_policy.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/access_policy_summary.py b/nipyapi/registry/models/access_policy_summary.py index 84d35ddd..8e3cf9dc 100644 --- a/nipyapi/registry/models/access_policy_summary.py +++ b/nipyapi/registry/models/access_policy_summary.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/allowable_value.py b/nipyapi/registry/models/allowable_value.py new file mode 100644 index 00000000..ee2d8e00 --- /dev/null +++ b/nipyapi/registry/models/allowable_value.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class AllowableValue(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'value': 'str', + 'display_name': 'str', + 'description': 'str' + } + + attribute_map = { + 'value': 'value', + 'display_name': 'displayName', + 'description': 'description' + } + + def __init__(self, value=None, display_name=None, description=None): + """ + AllowableValue - a model defined in Swagger + """ + + self._value = None + self._display_name = None + self._description = None + + if value is not None: + self.value = value + if display_name is not None: + self.display_name = display_name + if description is not None: + self.description = description + + @property + def value(self): + """ + Gets the value of this AllowableValue. + The value of the allowable value + + :return: The value of this AllowableValue. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this AllowableValue. + The value of the allowable value + + :param value: The value of this AllowableValue. + :type: str + """ + + self._value = value + + @property + def display_name(self): + """ + Gets the display_name of this AllowableValue. + The display name of the allowable value + + :return: The display_name of this AllowableValue. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this AllowableValue. + The display name of the allowable value + + :param display_name: The display_name of this AllowableValue. + :type: str + """ + + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this AllowableValue. + The description of the allowable value + + :return: The description of this AllowableValue. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this AllowableValue. + The description of the allowable value + + :param description: The description of this AllowableValue. + :type: str + """ + + self._description = description + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, AllowableValue): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/attribute.py b/nipyapi/registry/models/attribute.py new file mode 100644 index 00000000..978ea6ac --- /dev/null +++ b/nipyapi/registry/models/attribute.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class Attribute(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description' + } + + def __init__(self, name=None, description=None): + """ + Attribute - a model defined in Swagger + """ + + self._name = None + self._description = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + + @property + def name(self): + """ + Gets the name of this Attribute. + The name of the attribute + + :return: The name of this Attribute. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Attribute. + The name of the attribute + + :param name: The name of this Attribute. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this Attribute. + The description of the attribute + + :return: The description of this Attribute. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Attribute. + The description of the attribute + + :param description: The description of this Attribute. + :type: str + """ + + self._description = description + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Attribute): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/batch_size.py b/nipyapi/registry/models/batch_size.py index fb42302c..054db44a 100644 --- a/nipyapi/registry/models/batch_size.py +++ b/nipyapi/registry/models/batch_size.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bucket.py b/nipyapi/registry/models/bucket.py index 97f93748..65faf655 100644 --- a/nipyapi/registry/models/bucket.py +++ b/nipyapi/registry/models/bucket.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,11 +31,13 @@ class Bucket(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'identifier': 'str', 'name': 'str', 'created_timestamp': 'int', 'description': 'str', + 'allow_bundle_redeploy': 'bool', + 'allow_public_read': 'bool', 'permissions': 'Permissions' } @@ -45,10 +47,12 @@ class Bucket(object): 'name': 'name', 'created_timestamp': 'createdTimestamp', 'description': 'description', + 'allow_bundle_redeploy': 'allowBundleRedeploy', + 'allow_public_read': 'allowPublicRead', 'permissions': 'permissions' } - def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, permissions=None): + def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None): """ Bucket - a model defined in Swagger """ @@ -58,6 +62,8 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self._name = None self._created_timestamp = None self._description = None + self._allow_bundle_redeploy = None + self._allow_public_read = None self._permissions = None if link is not None: @@ -69,6 +75,10 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self.created_timestamp = created_timestamp if description is not None: self.description = description + if allow_bundle_redeploy is not None: + self.allow_bundle_redeploy = allow_bundle_redeploy + if allow_public_read is not None: + self.allow_public_read = allow_public_read if permissions is not None: self.permissions = permissions @@ -79,7 +89,7 @@ def link(self): An WebLink to this entity. :return: The link of this Bucket. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -90,7 +100,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this Bucket. - :type: Link + :type: JaxbLink """ self._link = link @@ -191,6 +201,52 @@ def description(self, description): self._description = description + @property + def allow_bundle_redeploy(self): + """ + 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. + + :return: The allow_bundle_redeploy of this Bucket. + :rtype: bool + """ + return self._allow_bundle_redeploy + + @allow_bundle_redeploy.setter + def allow_bundle_redeploy(self, allow_bundle_redeploy): + """ + Sets 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. + + :param allow_bundle_redeploy: The allow_bundle_redeploy of this Bucket. + :type: bool + """ + + self._allow_bundle_redeploy = allow_bundle_redeploy + + @property + def allow_public_read(self): + """ + Gets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users + + :return: The allow_public_read of this Bucket. + :rtype: bool + """ + return self._allow_public_read + + @allow_public_read.setter + def allow_public_read(self, allow_public_read): + """ + Sets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users + + :param allow_public_read: The allow_public_read of this Bucket. + :type: bool + """ + + self._allow_public_read = allow_public_read + @property def permissions(self): """ diff --git a/nipyapi/registry/models/bucket_item.py b/nipyapi/registry/models/bucket_item.py index 2f2fba4a..3444b54e 100644 --- a/nipyapi/registry/models/bucket_item.py +++ b/nipyapi/registry/models/bucket_item.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,7 +31,7 @@ class BucketItem(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'identifier': 'str', 'name': 'str', 'description': 'str', @@ -97,7 +97,7 @@ def link(self): An WebLink to this entity. :return: The link of this BucketItem. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -108,7 +108,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this BucketItem. - :type: Link + :type: JaxbLink """ self._link = link @@ -304,7 +304,7 @@ def type(self, type): """ if type is None: raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["Flow"] + allowed_values = ["Flow", "Bundle"] if type not in allowed_values: raise ValueError( "Invalid value for `type` ({0}), must be one of {1}" diff --git a/nipyapi/registry/models/build_info.py b/nipyapi/registry/models/build_info.py new file mode 100644 index 00000000..09ff6c2c --- /dev/null +++ b/nipyapi/registry/models/build_info.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class BuildInfo(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'build_tool': 'str', + 'build_flags': 'str', + 'build_branch': 'str', + 'build_tag': 'str', + 'build_revision': 'str', + 'built': 'int', + 'built_by': 'str' + } + + attribute_map = { + 'build_tool': 'buildTool', + 'build_flags': 'buildFlags', + 'build_branch': 'buildBranch', + 'build_tag': 'buildTag', + 'build_revision': 'buildRevision', + 'built': 'built', + 'built_by': 'builtBy' + } + + def __init__(self, build_tool=None, build_flags=None, build_branch=None, build_tag=None, build_revision=None, built=None, built_by=None): + """ + BuildInfo - a model defined in Swagger + """ + + self._build_tool = None + self._build_flags = None + self._build_branch = None + self._build_tag = None + self._build_revision = None + self._built = None + self._built_by = None + + if build_tool is not None: + self.build_tool = build_tool + if build_flags is not None: + self.build_flags = build_flags + if build_branch is not None: + self.build_branch = build_branch + if build_tag is not None: + self.build_tag = build_tag + if build_revision is not None: + self.build_revision = build_revision + if built is not None: + self.built = built + if built_by is not None: + self.built_by = built_by + + @property + def build_tool(self): + """ + Gets the build_tool of this BuildInfo. + The tool used to build the version of the bundle + + :return: The build_tool of this BuildInfo. + :rtype: str + """ + return self._build_tool + + @build_tool.setter + def build_tool(self, build_tool): + """ + Sets the build_tool of this BuildInfo. + The tool used to build the version of the bundle + + :param build_tool: The build_tool of this BuildInfo. + :type: str + """ + + self._build_tool = build_tool + + @property + def build_flags(self): + """ + Gets the build_flags of this BuildInfo. + The flags used to build the version of the bundle + + :return: The build_flags of this BuildInfo. + :rtype: str + """ + return self._build_flags + + @build_flags.setter + def build_flags(self, build_flags): + """ + Sets the build_flags of this BuildInfo. + The flags used to build the version of the bundle + + :param build_flags: The build_flags of this BuildInfo. + :type: str + """ + + self._build_flags = build_flags + + @property + def build_branch(self): + """ + Gets the build_branch of this BuildInfo. + The branch used to build the version of the bundle + + :return: The build_branch of this BuildInfo. + :rtype: str + """ + return self._build_branch + + @build_branch.setter + def build_branch(self, build_branch): + """ + Sets the build_branch of this BuildInfo. + The branch used to build the version of the bundle + + :param build_branch: The build_branch of this BuildInfo. + :type: str + """ + + self._build_branch = build_branch + + @property + def build_tag(self): + """ + Gets the build_tag of this BuildInfo. + The tag used to build the version of the bundle + + :return: The build_tag of this BuildInfo. + :rtype: str + """ + return self._build_tag + + @build_tag.setter + def build_tag(self, build_tag): + """ + Sets the build_tag of this BuildInfo. + The tag used to build the version of the bundle + + :param build_tag: The build_tag of this BuildInfo. + :type: str + """ + + self._build_tag = build_tag + + @property + def build_revision(self): + """ + Gets the build_revision of this BuildInfo. + The revision used to build the version of the bundle + + :return: The build_revision of this BuildInfo. + :rtype: str + """ + return self._build_revision + + @build_revision.setter + def build_revision(self, build_revision): + """ + Sets the build_revision of this BuildInfo. + The revision used to build the version of the bundle + + :param build_revision: The build_revision of this BuildInfo. + :type: str + """ + + self._build_revision = build_revision + + @property + def built(self): + """ + Gets the built of this BuildInfo. + The timestamp the version of the bundle was built + + :return: The built of this BuildInfo. + :rtype: int + """ + return self._built + + @built.setter + def built(self, built): + """ + Sets the built of this BuildInfo. + The timestamp the version of the bundle was built + + :param built: The built of this BuildInfo. + :type: int + """ + + self._built = built + + @property + def built_by(self): + """ + Gets the built_by of this BuildInfo. + The identity of the user that performed the build + + :return: The built_by of this BuildInfo. + :rtype: str + """ + return self._built_by + + @built_by.setter + def built_by(self, built_by): + """ + Sets the built_by of this BuildInfo. + The identity of the user that performed the build + + :param built_by: The built_by of this BuildInfo. + :type: str + """ + + self._built_by = built_by + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, BuildInfo): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/bundle.py b/nipyapi/registry/models/bundle.py index 487ec830..f3831997 100644 --- a/nipyapi/registry/models/bundle.py +++ b/nipyapi/registry/models/bundle.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_info.py b/nipyapi/registry/models/bundle_info.py new file mode 100644 index 00000000..599cd8c7 --- /dev/null +++ b/nipyapi/registry/models/bundle_info.py @@ -0,0 +1,327 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class BundleInfo(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'bucket_id': 'str', + 'bucket_name': 'str', + 'bundle_id': 'str', + 'bundle_type': 'str', + 'group_id': 'str', + 'artifact_id': 'str', + 'version': 'str', + 'system_api_version': 'str' + } + + attribute_map = { + 'bucket_id': 'bucketId', + 'bucket_name': 'bucketName', + 'bundle_id': 'bundleId', + 'bundle_type': 'bundleType', + 'group_id': 'groupId', + 'artifact_id': 'artifactId', + 'version': 'version', + 'system_api_version': 'systemApiVersion' + } + + def __init__(self, bucket_id=None, bucket_name=None, bundle_id=None, bundle_type=None, group_id=None, artifact_id=None, version=None, system_api_version=None): + """ + BundleInfo - a model defined in Swagger + """ + + self._bucket_id = None + self._bucket_name = None + self._bundle_id = None + self._bundle_type = None + self._group_id = None + self._artifact_id = None + self._version = None + self._system_api_version = None + + if bucket_id is not None: + self.bucket_id = bucket_id + if bucket_name is not None: + self.bucket_name = bucket_name + if bundle_id is not None: + self.bundle_id = bundle_id + if bundle_type is not None: + self.bundle_type = bundle_type + if group_id is not None: + self.group_id = group_id + if artifact_id is not None: + self.artifact_id = artifact_id + if version is not None: + self.version = version + if system_api_version is not None: + self.system_api_version = system_api_version + + @property + def bucket_id(self): + """ + Gets the bucket_id of this BundleInfo. + The id of the bucket where the bundle is located + + :return: The bucket_id of this BundleInfo. + :rtype: str + """ + return self._bucket_id + + @bucket_id.setter + def bucket_id(self, bucket_id): + """ + Sets the bucket_id of this BundleInfo. + The id of the bucket where the bundle is located + + :param bucket_id: The bucket_id of this BundleInfo. + :type: str + """ + + self._bucket_id = bucket_id + + @property + def bucket_name(self): + """ + Gets the bucket_name of this BundleInfo. + The name of the bucket where the bundle is located + + :return: The bucket_name of this BundleInfo. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this BundleInfo. + The name of the bucket where the bundle is located + + :param bucket_name: The bucket_name of this BundleInfo. + :type: str + """ + + self._bucket_name = bucket_name + + @property + def bundle_id(self): + """ + Gets the bundle_id of this BundleInfo. + The id of the bundle + + :return: The bundle_id of this BundleInfo. + :rtype: str + """ + return self._bundle_id + + @bundle_id.setter + def bundle_id(self, bundle_id): + """ + Sets the bundle_id of this BundleInfo. + The id of the bundle + + :param bundle_id: The bundle_id of this BundleInfo. + :type: str + """ + + self._bundle_id = bundle_id + + @property + def bundle_type(self): + """ + Gets the bundle_type of this BundleInfo. + The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP) + + :return: The bundle_type of this BundleInfo. + :rtype: str + """ + return self._bundle_type + + @bundle_type.setter + def bundle_type(self, bundle_type): + """ + Sets the bundle_type of this BundleInfo. + The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP) + + :param bundle_type: The bundle_type of this BundleInfo. + :type: str + """ + allowed_values = ["NIFI_NAR", "MINIFI_CPP"] + if bundle_type not in allowed_values: + raise ValueError( + "Invalid value for `bundle_type` ({0}), must be one of {1}" + .format(bundle_type, allowed_values) + ) + + self._bundle_type = bundle_type + + @property + def group_id(self): + """ + Gets the group_id of this BundleInfo. + The group id of the bundle + + :return: The group_id of this BundleInfo. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this BundleInfo. + The group id of the bundle + + :param group_id: The group_id of this BundleInfo. + :type: str + """ + + self._group_id = group_id + + @property + def artifact_id(self): + """ + Gets the artifact_id of this BundleInfo. + The artifact id of the bundle + + :return: The artifact_id of this BundleInfo. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this BundleInfo. + The artifact id of the bundle + + :param artifact_id: The artifact_id of this BundleInfo. + :type: str + """ + + self._artifact_id = artifact_id + + @property + def version(self): + """ + Gets the version of this BundleInfo. + The version of the bundle + + :return: The version of this BundleInfo. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this BundleInfo. + The version of the bundle + + :param version: The version of this BundleInfo. + :type: str + """ + + self._version = version + + @property + def system_api_version(self): + """ + Gets the system_api_version of this BundleInfo. + The version of the system API the bundle was built against + + :return: The system_api_version of this BundleInfo. + :rtype: str + """ + return self._system_api_version + + @system_api_version.setter + def system_api_version(self, system_api_version): + """ + Sets the system_api_version of this BundleInfo. + The version of the system API the bundle was built against + + :param system_api_version: The system_api_version of this BundleInfo. + :type: str + """ + + self._system_api_version = system_api_version + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, BundleInfo): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/bundle_version.py b/nipyapi/registry/models/bundle_version.py new file mode 100644 index 00000000..ca80773e --- /dev/null +++ b/nipyapi/registry/models/bundle_version.py @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class BundleVersion(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'version_metadata': 'BundleVersionMetadata', + 'dependencies': 'list[BundleVersionDependency]', + 'bundle': 'ExtensionBundle', + 'bucket': 'Bucket', + 'filename': 'str' + } + + attribute_map = { + 'link': 'link', + 'version_metadata': 'versionMetadata', + 'dependencies': 'dependencies', + 'bundle': 'bundle', + 'bucket': 'bucket', + 'filename': 'filename' + } + + def __init__(self, link=None, version_metadata=None, dependencies=None, bundle=None, bucket=None, filename=None): + """ + BundleVersion - a model defined in Swagger + """ + + self._link = None + self._version_metadata = None + self._dependencies = None + self._bundle = None + self._bucket = None + self._filename = None + + if link is not None: + self.link = link + self.version_metadata = version_metadata + if dependencies is not None: + self.dependencies = dependencies + if bundle is not None: + self.bundle = bundle + if bucket is not None: + self.bucket = bucket + if filename is not None: + self.filename = filename + + @property + def link(self): + """ + Gets the link of this BundleVersion. + An WebLink to this entity. + + :return: The link of this BundleVersion. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this BundleVersion. + An WebLink to this entity. + + :param link: The link of this BundleVersion. + :type: JaxbLink + """ + + self._link = link + + @property + def version_metadata(self): + """ + Gets the version_metadata of this BundleVersion. + The metadata about this version of the extension bundle + + :return: The version_metadata of this BundleVersion. + :rtype: BundleVersionMetadata + """ + return self._version_metadata + + @version_metadata.setter + def version_metadata(self, version_metadata): + """ + Sets the version_metadata of this BundleVersion. + The metadata about this version of the extension bundle + + :param version_metadata: The version_metadata of this BundleVersion. + :type: BundleVersionMetadata + """ + if version_metadata is None: + raise ValueError("Invalid value for `version_metadata`, must not be `None`") + + self._version_metadata = version_metadata + + @property + def dependencies(self): + """ + Gets the dependencies of this BundleVersion. + The set of other bundle versions that this version is dependent on + + :return: The dependencies of this BundleVersion. + :rtype: list[BundleVersionDependency] + """ + return self._dependencies + + @dependencies.setter + def dependencies(self, dependencies): + """ + Sets the dependencies of this BundleVersion. + The set of other bundle versions that this version is dependent on + + :param dependencies: The dependencies of this BundleVersion. + :type: list[BundleVersionDependency] + """ + + self._dependencies = dependencies + + @property + def bundle(self): + """ + Gets the bundle of this BundleVersion. + The bundle this version is for + + :return: The bundle of this BundleVersion. + :rtype: ExtensionBundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this BundleVersion. + The bundle this version is for + + :param bundle: The bundle of this BundleVersion. + :type: ExtensionBundle + """ + + self._bundle = bundle + + @property + def bucket(self): + """ + Gets the bucket of this BundleVersion. + The bucket that the extension bundle belongs to + + :return: The bucket of this BundleVersion. + :rtype: Bucket + """ + return self._bucket + + @bucket.setter + def bucket(self, bucket): + """ + Sets the bucket of this BundleVersion. + The bucket that the extension bundle belongs to + + :param bucket: The bucket of this BundleVersion. + :type: Bucket + """ + + self._bucket = bucket + + @property + def filename(self): + """ + Gets the filename of this BundleVersion. + + :return: The filename of this BundleVersion. + :rtype: str + """ + return self._filename + + @filename.setter + def filename(self, filename): + """ + Sets the filename of this BundleVersion. + + :param filename: The filename of this BundleVersion. + :type: str + """ + + self._filename = filename + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, BundleVersion): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/bundle_version_dependency.py b/nipyapi/registry/models/bundle_version_dependency.py new file mode 100644 index 00000000..9e4b1ad9 --- /dev/null +++ b/nipyapi/registry/models/bundle_version_dependency.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class BundleVersionDependency(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'group_id': 'str', + 'artifact_id': 'str', + 'version': 'str' + } + + attribute_map = { + 'group_id': 'groupId', + 'artifact_id': 'artifactId', + 'version': 'version' + } + + def __init__(self, group_id=None, artifact_id=None, version=None): + """ + BundleVersionDependency - a model defined in Swagger + """ + + self._group_id = None + self._artifact_id = None + self._version = None + + if group_id is not None: + self.group_id = group_id + if artifact_id is not None: + self.artifact_id = artifact_id + if version is not None: + self.version = version + + @property + def group_id(self): + """ + Gets the group_id of this BundleVersionDependency. + The group id of the bundle dependency + + :return: The group_id of this BundleVersionDependency. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this BundleVersionDependency. + The group id of the bundle dependency + + :param group_id: The group_id of this BundleVersionDependency. + :type: str + """ + + self._group_id = group_id + + @property + def artifact_id(self): + """ + Gets the artifact_id of this BundleVersionDependency. + The artifact id of the bundle dependency + + :return: The artifact_id of this BundleVersionDependency. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this BundleVersionDependency. + The artifact id of the bundle dependency + + :param artifact_id: The artifact_id of this BundleVersionDependency. + :type: str + """ + + self._artifact_id = artifact_id + + @property + def version(self): + """ + Gets the version of this BundleVersionDependency. + The version of the bundle dependency + + :return: The version of this BundleVersionDependency. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this BundleVersionDependency. + The version of the bundle dependency + + :param version: The version of this BundleVersionDependency. + :type: str + """ + + self._version = version + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, BundleVersionDependency): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/bundle_version_metadata.py b/nipyapi/registry/models/bundle_version_metadata.py new file mode 100644 index 00000000..de7963a9 --- /dev/null +++ b/nipyapi/registry/models/bundle_version_metadata.py @@ -0,0 +1,469 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class BundleVersionMetadata(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'id': 'str', + 'bundle_id': 'str', + 'bucket_id': 'str', + 'version': 'str', + 'timestamp': 'int', + 'author': 'str', + 'description': 'str', + 'sha256': 'str', + 'sha256_supplied': 'bool', + 'content_size': 'int', + 'system_api_version': 'str', + 'build_info': 'BuildInfo' + } + + attribute_map = { + 'link': 'link', + 'id': 'id', + 'bundle_id': 'bundleId', + 'bucket_id': 'bucketId', + 'version': 'version', + 'timestamp': 'timestamp', + 'author': 'author', + 'description': 'description', + 'sha256': 'sha256', + 'sha256_supplied': 'sha256Supplied', + 'content_size': 'contentSize', + 'system_api_version': 'systemApiVersion', + 'build_info': 'buildInfo' + } + + def __init__(self, link=None, id=None, bundle_id=None, bucket_id=None, version=None, timestamp=None, author=None, description=None, sha256=None, sha256_supplied=None, content_size=None, system_api_version=None, build_info=None): + """ + BundleVersionMetadata - a model defined in Swagger + """ + + self._link = None + self._id = None + self._bundle_id = None + self._bucket_id = None + self._version = None + self._timestamp = None + self._author = None + self._description = None + self._sha256 = None + self._sha256_supplied = None + self._content_size = None + self._system_api_version = None + self._build_info = None + + if link is not None: + self.link = link + if id is not None: + self.id = id + if bundle_id is not None: + self.bundle_id = bundle_id + self.bucket_id = bucket_id + if version is not None: + self.version = version + if timestamp is not None: + self.timestamp = timestamp + if author is not None: + self.author = author + if description is not None: + self.description = description + if sha256 is not None: + self.sha256 = sha256 + self.sha256_supplied = sha256_supplied + self.content_size = content_size + if system_api_version is not None: + self.system_api_version = system_api_version + self.build_info = build_info + + @property + def link(self): + """ + Gets the link of this BundleVersionMetadata. + An WebLink to this entity. + + :return: The link of this BundleVersionMetadata. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this BundleVersionMetadata. + An WebLink to this entity. + + :param link: The link of this BundleVersionMetadata. + :type: JaxbLink + """ + + self._link = link + + @property + def id(self): + """ + Gets the id of this BundleVersionMetadata. + The id of this version of the extension bundle + + :return: The id of this BundleVersionMetadata. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this BundleVersionMetadata. + The id of this version of the extension bundle + + :param id: The id of this BundleVersionMetadata. + :type: str + """ + + self._id = id + + @property + def bundle_id(self): + """ + Gets the bundle_id of this BundleVersionMetadata. + The id of the extension bundle this version is for + + :return: The bundle_id of this BundleVersionMetadata. + :rtype: str + """ + return self._bundle_id + + @bundle_id.setter + def bundle_id(self, bundle_id): + """ + Sets the bundle_id of this BundleVersionMetadata. + The id of the extension bundle this version is for + + :param bundle_id: The bundle_id of this BundleVersionMetadata. + :type: str + """ + + self._bundle_id = bundle_id + + @property + def bucket_id(self): + """ + Gets the bucket_id of this BundleVersionMetadata. + The id of the bucket the extension bundle belongs to + + :return: The bucket_id of this BundleVersionMetadata. + :rtype: str + """ + return self._bucket_id + + @bucket_id.setter + def bucket_id(self, bucket_id): + """ + Sets the bucket_id of this BundleVersionMetadata. + The id of the bucket the extension bundle belongs to + + :param bucket_id: The bucket_id of this BundleVersionMetadata. + :type: str + """ + if bucket_id is None: + raise ValueError("Invalid value for `bucket_id`, must not be `None`") + + self._bucket_id = bucket_id + + @property + def version(self): + """ + Gets the version of this BundleVersionMetadata. + The version of the extension bundle + + :return: The version of this BundleVersionMetadata. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this BundleVersionMetadata. + The version of the extension bundle + + :param version: The version of this BundleVersionMetadata. + :type: str + """ + + self._version = version + + @property + def timestamp(self): + """ + Gets the timestamp of this BundleVersionMetadata. + The timestamp of the create date of this version + + :return: The timestamp of this BundleVersionMetadata. + :rtype: int + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this BundleVersionMetadata. + The timestamp of the create date of this version + + :param timestamp: The timestamp of this BundleVersionMetadata. + :type: int + """ + if timestamp is not None and timestamp < 1: + raise ValueError("Invalid value for `timestamp`, must be a value greater than or equal to `1`") + + self._timestamp = timestamp + + @property + def author(self): + """ + Gets the author of this BundleVersionMetadata. + The identity that created this version + + :return: The author of this BundleVersionMetadata. + :rtype: str + """ + return self._author + + @author.setter + def author(self, author): + """ + Sets the author of this BundleVersionMetadata. + The identity that created this version + + :param author: The author of this BundleVersionMetadata. + :type: str + """ + + self._author = author + + @property + def description(self): + """ + Gets the description of this BundleVersionMetadata. + The description for this version + + :return: The description of this BundleVersionMetadata. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this BundleVersionMetadata. + The description for this version + + :param description: The description of this BundleVersionMetadata. + :type: str + """ + + self._description = description + + @property + def sha256(self): + """ + Gets the sha256 of this BundleVersionMetadata. + The hex representation of the SHA-256 digest of the binary content for this version + + :return: The sha256 of this BundleVersionMetadata. + :rtype: str + """ + return self._sha256 + + @sha256.setter + def sha256(self, sha256): + """ + Sets the sha256 of this BundleVersionMetadata. + The hex representation of the SHA-256 digest of the binary content for this version + + :param sha256: The sha256 of this BundleVersionMetadata. + :type: str + """ + + self._sha256 = sha256 + + @property + def sha256_supplied(self): + """ + Gets the sha256_supplied of this BundleVersionMetadata. + Whether or not the client supplied a SHA-256 when uploading the bundle + + :return: The sha256_supplied of this BundleVersionMetadata. + :rtype: bool + """ + return self._sha256_supplied + + @sha256_supplied.setter + def sha256_supplied(self, sha256_supplied): + """ + Sets the sha256_supplied of this BundleVersionMetadata. + Whether or not the client supplied a SHA-256 when uploading the bundle + + :param sha256_supplied: The sha256_supplied of this BundleVersionMetadata. + :type: bool + """ + if sha256_supplied is None: + raise ValueError("Invalid value for `sha256_supplied`, must not be `None`") + + self._sha256_supplied = sha256_supplied + + @property + def content_size(self): + """ + Gets the content_size of this BundleVersionMetadata. + The size of the binary content for this version in bytes + + :return: The content_size of this BundleVersionMetadata. + :rtype: int + """ + return self._content_size + + @content_size.setter + def content_size(self, content_size): + """ + Sets the content_size of this BundleVersionMetadata. + The size of the binary content for this version in bytes + + :param content_size: The content_size of this BundleVersionMetadata. + :type: int + """ + if content_size is None: + raise ValueError("Invalid value for `content_size`, must not be `None`") + if content_size is not None and content_size < 0: + raise ValueError("Invalid value for `content_size`, must be a value greater than or equal to `0`") + + self._content_size = content_size + + @property + def system_api_version(self): + """ + Gets the system_api_version of this BundleVersionMetadata. + The version of the system API that this bundle version was built against + + :return: The system_api_version of this BundleVersionMetadata. + :rtype: str + """ + return self._system_api_version + + @system_api_version.setter + def system_api_version(self, system_api_version): + """ + Sets the system_api_version of this BundleVersionMetadata. + The version of the system API that this bundle version was built against + + :param system_api_version: The system_api_version of this BundleVersionMetadata. + :type: str + """ + + self._system_api_version = system_api_version + + @property + def build_info(self): + """ + Gets the build_info of this BundleVersionMetadata. + The build information about this version + + :return: The build_info of this BundleVersionMetadata. + :rtype: BuildInfo + """ + return self._build_info + + @build_info.setter + def build_info(self, build_info): + """ + Sets the build_info of this BundleVersionMetadata. + The build information about this version + + :param build_info: The build_info of this BundleVersionMetadata. + :type: BuildInfo + """ + if build_info is None: + raise ValueError("Invalid value for `build_info`, must not be `None`") + + self._build_info = build_info + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, BundleVersionMetadata): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/component_difference.py b/nipyapi/registry/models/component_difference.py index 83803131..61d4c563 100644 --- a/nipyapi/registry/models/component_difference.py +++ b/nipyapi/registry/models/component_difference.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/component_difference_group.py b/nipyapi/registry/models/component_difference_group.py index 0bdef8d3..3c939d7f 100644 --- a/nipyapi/registry/models/component_difference_group.py +++ b/nipyapi/registry/models/component_difference_group.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/connectable_component.py b/nipyapi/registry/models/connectable_component.py index b439490d..2ca0c5f7 100644 --- a/nipyapi/registry/models/connectable_component.py +++ b/nipyapi/registry/models/connectable_component.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/controller_service_api.py b/nipyapi/registry/models/controller_service_api.py index 6f843425..324422b9 100644 --- a/nipyapi/registry/models/controller_service_api.py +++ b/nipyapi/registry/models/controller_service_api.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/controller_service_definition.py b/nipyapi/registry/models/controller_service_definition.py new file mode 100644 index 00000000..4e359280 --- /dev/null +++ b/nipyapi/registry/models/controller_service_definition.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ControllerServiceDefinition(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'class_name': 'str', + 'group_id': 'str', + 'artifact_id': 'str', + 'version': 'str' + } + + attribute_map = { + 'class_name': 'className', + 'group_id': 'groupId', + 'artifact_id': 'artifactId', + 'version': 'version' + } + + def __init__(self, class_name=None, group_id=None, artifact_id=None, version=None): + """ + ControllerServiceDefinition - a model defined in Swagger + """ + + self._class_name = None + self._group_id = None + self._artifact_id = None + self._version = None + + if class_name is not None: + self.class_name = class_name + if group_id is not None: + self.group_id = group_id + if artifact_id is not None: + self.artifact_id = artifact_id + if version is not None: + self.version = version + + @property + def class_name(self): + """ + Gets the class_name of this ControllerServiceDefinition. + The class name of the service API + + :return: The class_name of this ControllerServiceDefinition. + :rtype: str + """ + return self._class_name + + @class_name.setter + def class_name(self, class_name): + """ + Sets the class_name of this ControllerServiceDefinition. + The class name of the service API + + :param class_name: The class_name of this ControllerServiceDefinition. + :type: str + """ + + self._class_name = class_name + + @property + def group_id(self): + """ + Gets the group_id of this ControllerServiceDefinition. + The group id of the service API + + :return: The group_id of this ControllerServiceDefinition. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ControllerServiceDefinition. + The group id of the service API + + :param group_id: The group_id of this ControllerServiceDefinition. + :type: str + """ + + self._group_id = group_id + + @property + def artifact_id(self): + """ + Gets the artifact_id of this ControllerServiceDefinition. + The artifact id of the service API + + :return: The artifact_id of this ControllerServiceDefinition. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this ControllerServiceDefinition. + The artifact id of the service API + + :param artifact_id: The artifact_id of this ControllerServiceDefinition. + :type: str + """ + + self._artifact_id = artifact_id + + @property + def version(self): + """ + Gets the version of this ControllerServiceDefinition. + The version of the service API + + :return: The version of this ControllerServiceDefinition. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this ControllerServiceDefinition. + The version of the service API + + :param version: The version of this ControllerServiceDefinition. + :type: str + """ + + self._version = version + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ControllerServiceDefinition): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/current_user.py b/nipyapi/registry/models/current_user.py index a5c99895..af718f3a 100644 --- a/nipyapi/registry/models/current_user.py +++ b/nipyapi/registry/models/current_user.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,28 +33,33 @@ class CurrentUser(object): swagger_types = { 'identity': 'str', 'anonymous': 'bool', + 'login_supported': 'bool', 'resource_permissions': 'ResourcePermissions' } attribute_map = { 'identity': 'identity', 'anonymous': 'anonymous', + 'login_supported': 'loginSupported', 'resource_permissions': 'resourcePermissions' } - def __init__(self, identity=None, anonymous=None, resource_permissions=None): + def __init__(self, identity=None, anonymous=None, login_supported=None, resource_permissions=None): """ CurrentUser - a model defined in Swagger """ self._identity = None self._anonymous = None + self._login_supported = None self._resource_permissions = None if identity is not None: self.identity = identity if anonymous is not None: self.anonymous = anonymous + if login_supported is not None: + self.login_supported = login_supported if resource_permissions is not None: self.resource_permissions = resource_permissions @@ -104,6 +109,29 @@ def anonymous(self, anonymous): self._anonymous = anonymous + @property + def login_supported(self): + """ + Gets the login_supported of this CurrentUser. + Indicates if the NiFi instance supports logging in + + :return: The login_supported of this CurrentUser. + :rtype: bool + """ + return self._login_supported + + @login_supported.setter + def login_supported(self, login_supported): + """ + Sets the login_supported of this CurrentUser. + Indicates if the NiFi instance supports logging in + + :param login_supported: The login_supported of this CurrentUser. + :type: bool + """ + + self._login_supported = login_supported + @property def resource_permissions(self): """ diff --git a/nipyapi/registry/models/deprecation_notice.py b/nipyapi/registry/models/deprecation_notice.py new file mode 100644 index 00000000..454c3151 --- /dev/null +++ b/nipyapi/registry/models/deprecation_notice.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class DeprecationNotice(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'reason': 'str', + 'alternatives': 'list[str]' + } + + attribute_map = { + 'reason': 'reason', + 'alternatives': 'alternatives' + } + + def __init__(self, reason=None, alternatives=None): + """ + DeprecationNotice - a model defined in Swagger + """ + + self._reason = None + self._alternatives = None + + if reason is not None: + self.reason = reason + if alternatives is not None: + self.alternatives = alternatives + + @property + def reason(self): + """ + Gets the reason of this DeprecationNotice. + The reason for the deprecation + + :return: The reason of this DeprecationNotice. + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """ + Sets the reason of this DeprecationNotice. + The reason for the deprecation + + :param reason: The reason of this DeprecationNotice. + :type: str + """ + + self._reason = reason + + @property + def alternatives(self): + """ + Gets the alternatives of this DeprecationNotice. + The alternatives to use + + :return: The alternatives of this DeprecationNotice. + :rtype: list[str] + """ + return self._alternatives + + @alternatives.setter + def alternatives(self, alternatives): + """ + Sets the alternatives of this DeprecationNotice. + The alternatives to use + + :param alternatives: The alternatives of this DeprecationNotice. + :type: list[str] + """ + + self._alternatives = alternatives + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, DeprecationNotice): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/dynamic_property.py b/nipyapi/registry/models/dynamic_property.py new file mode 100644 index 00000000..b261ea10 --- /dev/null +++ b/nipyapi/registry/models/dynamic_property.py @@ -0,0 +1,243 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class DynamicProperty(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'value': 'str', + 'description': 'str', + 'expression_language_scope': 'str', + 'expression_language_supported': 'bool' + } + + attribute_map = { + 'name': 'name', + 'value': 'value', + 'description': 'description', + 'expression_language_scope': 'expressionLanguageScope', + 'expression_language_supported': 'expressionLanguageSupported' + } + + def __init__(self, name=None, value=None, description=None, expression_language_scope=None, expression_language_supported=None): + """ + DynamicProperty - a model defined in Swagger + """ + + self._name = None + self._value = None + self._description = None + self._expression_language_scope = None + self._expression_language_supported = None + + if name is not None: + self.name = name + if value is not None: + self.value = value + if description is not None: + self.description = description + if expression_language_scope is not None: + self.expression_language_scope = expression_language_scope + if expression_language_supported is not None: + self.expression_language_supported = expression_language_supported + + @property + def name(self): + """ + Gets the name of this DynamicProperty. + The description of the dynamic property name + + :return: The name of this DynamicProperty. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DynamicProperty. + The description of the dynamic property name + + :param name: The name of this DynamicProperty. + :type: str + """ + + self._name = name + + @property + def value(self): + """ + Gets the value of this DynamicProperty. + The description of the dynamic property value + + :return: The value of this DynamicProperty. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this DynamicProperty. + The description of the dynamic property value + + :param value: The value of this DynamicProperty. + :type: str + """ + + self._value = value + + @property + def description(self): + """ + Gets the description of this DynamicProperty. + The description of the dynamic property + + :return: The description of this DynamicProperty. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DynamicProperty. + The description of the dynamic property + + :param description: The description of this DynamicProperty. + :type: str + """ + + self._description = description + + @property + def expression_language_scope(self): + """ + Gets the expression_language_scope of this DynamicProperty. + The scope of the expression language support + + :return: The expression_language_scope of this DynamicProperty. + :rtype: str + """ + return self._expression_language_scope + + @expression_language_scope.setter + def expression_language_scope(self, expression_language_scope): + """ + Sets the expression_language_scope of this DynamicProperty. + The scope of the expression language support + + :param expression_language_scope: The expression_language_scope of this DynamicProperty. + :type: str + """ + allowed_values = ["NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES"] + if expression_language_scope not in allowed_values: + raise ValueError( + "Invalid value for `expression_language_scope` ({0}), must be one of {1}" + .format(expression_language_scope, allowed_values) + ) + + self._expression_language_scope = expression_language_scope + + @property + def expression_language_supported(self): + """ + Gets the expression_language_supported of this DynamicProperty. + Whether or not expression language is supported + + :return: The expression_language_supported of this DynamicProperty. + :rtype: bool + """ + return self._expression_language_supported + + @expression_language_supported.setter + def expression_language_supported(self, expression_language_supported): + """ + Sets the expression_language_supported of this DynamicProperty. + Whether or not expression language is supported + + :param expression_language_supported: The expression_language_supported of this DynamicProperty. + :type: bool + """ + + self._expression_language_supported = expression_language_supported + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, DynamicProperty): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/dynamic_relationship.py b/nipyapi/registry/models/dynamic_relationship.py new file mode 100644 index 00000000..3700ddb0 --- /dev/null +++ b/nipyapi/registry/models/dynamic_relationship.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class DynamicRelationship(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description' + } + + def __init__(self, name=None, description=None): + """ + DynamicRelationship - a model defined in Swagger + """ + + self._name = None + self._description = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + + @property + def name(self): + """ + Gets the name of this DynamicRelationship. + The description of the dynamic relationship name + + :return: The name of this DynamicRelationship. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this DynamicRelationship. + The description of the dynamic relationship name + + :param name: The name of this DynamicRelationship. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this DynamicRelationship. + The description of the dynamic relationship + + :return: The description of this DynamicRelationship. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this DynamicRelationship. + The description of the dynamic relationship + + :param description: The description of this DynamicRelationship. + :type: str + """ + + self._description = description + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, DynamicRelationship): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension.py b/nipyapi/registry/models/extension.py new file mode 100644 index 00000000..fb2ee08a --- /dev/null +++ b/nipyapi/registry/models/extension.py @@ -0,0 +1,585 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class Extension(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'type': 'str', + 'deprecation_notice': 'DeprecationNotice', + 'description': 'str', + 'tags': 'list[str]', + 'properties': 'list[ModelProperty]', + 'dynamic_properties': 'list[DynamicProperty]', + 'relationships': 'list[Relationship]', + 'dynamic_relationship': 'DynamicRelationship', + 'reads_attributes': 'list[Attribute]', + 'writes_attributes': 'list[Attribute]', + 'stateful': 'Stateful', + 'restricted': 'Restricted', + 'input_requirement': 'str', + 'system_resource_considerations': 'list[SystemResourceConsideration]', + 'see_also': 'list[str]', + 'provided_service_ap_is': 'list[ProvidedServiceAPI]' + } + + attribute_map = { + 'name': 'name', + 'type': 'type', + 'deprecation_notice': 'deprecationNotice', + 'description': 'description', + 'tags': 'tags', + 'properties': 'properties', + 'dynamic_properties': 'dynamicProperties', + 'relationships': 'relationships', + 'dynamic_relationship': 'dynamicRelationship', + 'reads_attributes': 'readsAttributes', + 'writes_attributes': 'writesAttributes', + 'stateful': 'stateful', + 'restricted': 'restricted', + 'input_requirement': 'inputRequirement', + 'system_resource_considerations': 'systemResourceConsiderations', + 'see_also': 'seeAlso', + 'provided_service_ap_is': 'providedServiceAPIs' + } + + def __init__(self, name=None, type=None, deprecation_notice=None, description=None, tags=None, properties=None, dynamic_properties=None, relationships=None, dynamic_relationship=None, reads_attributes=None, writes_attributes=None, stateful=None, restricted=None, input_requirement=None, system_resource_considerations=None, see_also=None, provided_service_ap_is=None): + """ + Extension - a model defined in Swagger + """ + + self._name = None + self._type = None + self._deprecation_notice = None + self._description = None + self._tags = None + self._properties = None + self._dynamic_properties = None + self._relationships = None + self._dynamic_relationship = None + self._reads_attributes = None + self._writes_attributes = None + self._stateful = None + self._restricted = None + self._input_requirement = None + self._system_resource_considerations = None + self._see_also = None + self._provided_service_ap_is = None + + if name is not None: + self.name = name + if type is not None: + self.type = type + if deprecation_notice is not None: + self.deprecation_notice = deprecation_notice + if description is not None: + self.description = description + if tags is not None: + self.tags = tags + if properties is not None: + self.properties = properties + if dynamic_properties is not None: + self.dynamic_properties = dynamic_properties + if relationships is not None: + self.relationships = relationships + if dynamic_relationship is not None: + self.dynamic_relationship = dynamic_relationship + if reads_attributes is not None: + self.reads_attributes = reads_attributes + if writes_attributes is not None: + self.writes_attributes = writes_attributes + if stateful is not None: + self.stateful = stateful + if restricted is not None: + self.restricted = restricted + if input_requirement is not None: + self.input_requirement = input_requirement + if system_resource_considerations is not None: + self.system_resource_considerations = system_resource_considerations + if see_also is not None: + self.see_also = see_also + if provided_service_ap_is is not None: + self.provided_service_ap_is = provided_service_ap_is + + @property + def name(self): + """ + Gets the name of this Extension. + The name of the extension + + :return: The name of this Extension. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Extension. + The name of the extension + + :param name: The name of this Extension. + :type: str + """ + + self._name = name + + @property + def type(self): + """ + Gets the type of this Extension. + The type of the extension + + :return: The type of this Extension. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this Extension. + The type of the extension + + :param type: The type of this Extension. + :type: str + """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK"] + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) + ) + + self._type = type + + @property + def deprecation_notice(self): + """ + Gets the deprecation_notice of this Extension. + The deprecation notice of the extension + + :return: The deprecation_notice of this Extension. + :rtype: DeprecationNotice + """ + return self._deprecation_notice + + @deprecation_notice.setter + def deprecation_notice(self, deprecation_notice): + """ + Sets the deprecation_notice of this Extension. + The deprecation notice of the extension + + :param deprecation_notice: The deprecation_notice of this Extension. + :type: DeprecationNotice + """ + + self._deprecation_notice = deprecation_notice + + @property + def description(self): + """ + Gets the description of this Extension. + The description of the extension + + :return: The description of this Extension. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Extension. + The description of the extension + + :param description: The description of this Extension. + :type: str + """ + + self._description = description + + @property + def tags(self): + """ + Gets the tags of this Extension. + The tags of the extension + + :return: The tags of this Extension. + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """ + Sets the tags of this Extension. + The tags of the extension + + :param tags: The tags of this Extension. + :type: list[str] + """ + + self._tags = tags + + @property + def properties(self): + """ + Gets the properties of this Extension. + The properties of the extension + + :return: The properties of this Extension. + :rtype: list[ModelProperty] + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this Extension. + The properties of the extension + + :param properties: The properties of this Extension. + :type: list[ModelProperty] + """ + + self._properties = properties + + @property + def dynamic_properties(self): + """ + Gets the dynamic_properties of this Extension. + The dynamic properties of the extension + + :return: The dynamic_properties of this Extension. + :rtype: list[DynamicProperty] + """ + return self._dynamic_properties + + @dynamic_properties.setter + def dynamic_properties(self, dynamic_properties): + """ + Sets the dynamic_properties of this Extension. + The dynamic properties of the extension + + :param dynamic_properties: The dynamic_properties of this Extension. + :type: list[DynamicProperty] + """ + + self._dynamic_properties = dynamic_properties + + @property + def relationships(self): + """ + Gets the relationships of this Extension. + The relationships of the extension + + :return: The relationships of this Extension. + :rtype: list[Relationship] + """ + return self._relationships + + @relationships.setter + def relationships(self, relationships): + """ + Sets the relationships of this Extension. + The relationships of the extension + + :param relationships: The relationships of this Extension. + :type: list[Relationship] + """ + + self._relationships = relationships + + @property + def dynamic_relationship(self): + """ + Gets the dynamic_relationship of this Extension. + The dynamic relationships of the extension + + :return: The dynamic_relationship of this Extension. + :rtype: DynamicRelationship + """ + return self._dynamic_relationship + + @dynamic_relationship.setter + def dynamic_relationship(self, dynamic_relationship): + """ + Sets the dynamic_relationship of this Extension. + The dynamic relationships of the extension + + :param dynamic_relationship: The dynamic_relationship of this Extension. + :type: DynamicRelationship + """ + + self._dynamic_relationship = dynamic_relationship + + @property + def reads_attributes(self): + """ + Gets the reads_attributes of this Extension. + The attributes read from flow files by the extension + + :return: The reads_attributes of this Extension. + :rtype: list[Attribute] + """ + return self._reads_attributes + + @reads_attributes.setter + def reads_attributes(self, reads_attributes): + """ + Sets the reads_attributes of this Extension. + The attributes read from flow files by the extension + + :param reads_attributes: The reads_attributes of this Extension. + :type: list[Attribute] + """ + + self._reads_attributes = reads_attributes + + @property + def writes_attributes(self): + """ + Gets the writes_attributes of this Extension. + The attributes written to flow files by the extension + + :return: The writes_attributes of this Extension. + :rtype: list[Attribute] + """ + return self._writes_attributes + + @writes_attributes.setter + def writes_attributes(self, writes_attributes): + """ + Sets the writes_attributes of this Extension. + The attributes written to flow files by the extension + + :param writes_attributes: The writes_attributes of this Extension. + :type: list[Attribute] + """ + + self._writes_attributes = writes_attributes + + @property + def stateful(self): + """ + Gets the stateful of this Extension. + The information about how the extension stores state + + :return: The stateful of this Extension. + :rtype: Stateful + """ + return self._stateful + + @stateful.setter + def stateful(self, stateful): + """ + Sets the stateful of this Extension. + The information about how the extension stores state + + :param stateful: The stateful of this Extension. + :type: Stateful + """ + + self._stateful = stateful + + @property + def restricted(self): + """ + Gets the restricted of this Extension. + The restrictions of the extension + + :return: The restricted of this Extension. + :rtype: Restricted + """ + return self._restricted + + @restricted.setter + def restricted(self, restricted): + """ + Sets the restricted of this Extension. + The restrictions of the extension + + :param restricted: The restricted of this Extension. + :type: Restricted + """ + + self._restricted = restricted + + @property + def input_requirement(self): + """ + Gets the input_requirement of this Extension. + The input requirement of the extension + + :return: The input_requirement of this Extension. + :rtype: str + """ + return self._input_requirement + + @input_requirement.setter + def input_requirement(self, input_requirement): + """ + Sets the input_requirement of this Extension. + The input requirement of the extension + + :param input_requirement: The input_requirement of this Extension. + :type: str + """ + allowed_values = ["INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN"] + if input_requirement not in allowed_values: + raise ValueError( + "Invalid value for `input_requirement` ({0}), must be one of {1}" + .format(input_requirement, allowed_values) + ) + + self._input_requirement = input_requirement + + @property + def system_resource_considerations(self): + """ + Gets the system_resource_considerations of this Extension. + The resource considerations of the extension + + :return: The system_resource_considerations of this Extension. + :rtype: list[SystemResourceConsideration] + """ + return self._system_resource_considerations + + @system_resource_considerations.setter + def system_resource_considerations(self, system_resource_considerations): + """ + Sets the system_resource_considerations of this Extension. + The resource considerations of the extension + + :param system_resource_considerations: The system_resource_considerations of this Extension. + :type: list[SystemResourceConsideration] + """ + + self._system_resource_considerations = system_resource_considerations + + @property + def see_also(self): + """ + Gets the see_also of this Extension. + The names of other extensions to see + + :return: The see_also of this Extension. + :rtype: list[str] + """ + return self._see_also + + @see_also.setter + def see_also(self, see_also): + """ + Sets the see_also of this Extension. + The names of other extensions to see + + :param see_also: The see_also of this Extension. + :type: list[str] + """ + + self._see_also = see_also + + @property + def provided_service_ap_is(self): + """ + Gets the provided_service_ap_is of this Extension. + The service APIs provided by this extension + + :return: The provided_service_ap_is of this Extension. + :rtype: list[ProvidedServiceAPI] + """ + return self._provided_service_ap_is + + @provided_service_ap_is.setter + def provided_service_ap_is(self, provided_service_ap_is): + """ + Sets the provided_service_ap_is of this Extension. + The service APIs provided by this extension + + :param provided_service_ap_is: The provided_service_ap_is of this Extension. + :type: list[ProvidedServiceAPI] + """ + + self._provided_service_ap_is = provided_service_ap_is + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Extension): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_bundle.py b/nipyapi/registry/models/extension_bundle.py new file mode 100644 index 00000000..296af2b5 --- /dev/null +++ b/nipyapi/registry/models/extension_bundle.py @@ -0,0 +1,511 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionBundle(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'identifier': 'str', + 'name': 'str', + 'description': 'str', + 'bucket_identifier': 'str', + 'bucket_name': 'str', + 'created_timestamp': 'int', + 'modified_timestamp': 'int', + 'type': 'str', + 'permissions': 'Permissions', + 'bundle_type': 'str', + 'group_id': 'str', + 'artifact_id': 'str', + 'version_count': 'int' + } + + attribute_map = { + 'link': 'link', + 'identifier': 'identifier', + 'name': 'name', + 'description': 'description', + 'bucket_identifier': 'bucketIdentifier', + 'bucket_name': 'bucketName', + 'created_timestamp': 'createdTimestamp', + 'modified_timestamp': 'modifiedTimestamp', + 'type': 'type', + 'permissions': 'permissions', + 'bundle_type': 'bundleType', + 'group_id': 'groupId', + 'artifact_id': 'artifactId', + 'version_count': 'versionCount' + } + + def __init__(self, link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None, bundle_type=None, group_id=None, artifact_id=None, version_count=None): + """ + ExtensionBundle - a model defined in Swagger + """ + + self._link = None + self._identifier = None + self._name = None + self._description = None + self._bucket_identifier = None + self._bucket_name = None + self._created_timestamp = None + self._modified_timestamp = None + self._type = None + self._permissions = None + self._bundle_type = None + self._group_id = None + self._artifact_id = None + self._version_count = None + + if link is not None: + self.link = link + if identifier is not None: + self.identifier = identifier + self.name = name + if description is not None: + self.description = description + self.bucket_identifier = bucket_identifier + if bucket_name is not None: + self.bucket_name = bucket_name + if created_timestamp is not None: + self.created_timestamp = created_timestamp + if modified_timestamp is not None: + self.modified_timestamp = modified_timestamp + self.type = type + if permissions is not None: + self.permissions = permissions + self.bundle_type = bundle_type + if group_id is not None: + self.group_id = group_id + if artifact_id is not None: + self.artifact_id = artifact_id + if version_count is not None: + self.version_count = version_count + + @property + def link(self): + """ + Gets the link of this ExtensionBundle. + An WebLink to this entity. + + :return: The link of this ExtensionBundle. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionBundle. + An WebLink to this entity. + + :param link: The link of this ExtensionBundle. + :type: JaxbLink + """ + + self._link = link + + @property + def identifier(self): + """ + Gets the identifier of this ExtensionBundle. + An ID to uniquely identify this object. + + :return: The identifier of this ExtensionBundle. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ExtensionBundle. + An ID to uniquely identify this object. + + :param identifier: The identifier of this ExtensionBundle. + :type: str + """ + + self._identifier = identifier + + @property + def name(self): + """ + Gets the name of this ExtensionBundle. + The name of the item. + + :return: The name of this ExtensionBundle. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ExtensionBundle. + The name of the item. + + :param name: The name of this ExtensionBundle. + :type: str + """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") + + self._name = name + + @property + def description(self): + """ + Gets the description of this ExtensionBundle. + A description of the item. + + :return: The description of this ExtensionBundle. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ExtensionBundle. + A description of the item. + + :param description: The description of this ExtensionBundle. + :type: str + """ + + self._description = description + + @property + def bucket_identifier(self): + """ + Gets the bucket_identifier of this ExtensionBundle. + The identifier of the bucket this items belongs to. This cannot be changed after the item is created. + + :return: The bucket_identifier of this ExtensionBundle. + :rtype: str + """ + return self._bucket_identifier + + @bucket_identifier.setter + def bucket_identifier(self, bucket_identifier): + """ + Sets the bucket_identifier of this ExtensionBundle. + The identifier of the bucket this items belongs to. This cannot be changed after the item is created. + + :param bucket_identifier: The bucket_identifier of this ExtensionBundle. + :type: str + """ + if bucket_identifier is None: + raise ValueError("Invalid value for `bucket_identifier`, must not be `None`") + + self._bucket_identifier = bucket_identifier + + @property + def bucket_name(self): + """ + Gets the bucket_name of this ExtensionBundle. + The name of the bucket this items belongs to. + + :return: The bucket_name of this ExtensionBundle. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this ExtensionBundle. + The name of the bucket this items belongs to. + + :param bucket_name: The bucket_name of this ExtensionBundle. + :type: str + """ + + self._bucket_name = bucket_name + + @property + def created_timestamp(self): + """ + Gets the created_timestamp of this ExtensionBundle. + The timestamp of when the item was created, as milliseconds since epoch. + + :return: The created_timestamp of this ExtensionBundle. + :rtype: int + """ + return self._created_timestamp + + @created_timestamp.setter + def created_timestamp(self, created_timestamp): + """ + Sets the created_timestamp of this ExtensionBundle. + The timestamp of when the item was created, as milliseconds since epoch. + + :param created_timestamp: The created_timestamp of this ExtensionBundle. + :type: int + """ + if created_timestamp is not None and created_timestamp < 1: + raise ValueError("Invalid value for `created_timestamp`, must be a value greater than or equal to `1`") + + self._created_timestamp = created_timestamp + + @property + def modified_timestamp(self): + """ + Gets the modified_timestamp of this ExtensionBundle. + The timestamp of when the item was last modified, as milliseconds since epoch. + + :return: The modified_timestamp of this ExtensionBundle. + :rtype: int + """ + return self._modified_timestamp + + @modified_timestamp.setter + def modified_timestamp(self, modified_timestamp): + """ + Sets the modified_timestamp of this ExtensionBundle. + The timestamp of when the item was last modified, as milliseconds since epoch. + + :param modified_timestamp: The modified_timestamp of this ExtensionBundle. + :type: int + """ + if modified_timestamp is not None and modified_timestamp < 1: + raise ValueError("Invalid value for `modified_timestamp`, must be a value greater than or equal to `1`") + + self._modified_timestamp = modified_timestamp + + @property + def type(self): + """ + Gets the type of this ExtensionBundle. + The type of item. + + :return: The type of this ExtensionBundle. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ExtensionBundle. + The type of item. + + :param type: The type of this ExtensionBundle. + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") + allowed_values = ["Flow", "Bundle"] + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) + ) + + self._type = type + + @property + def permissions(self): + """ + Gets the permissions of this ExtensionBundle. + The access that the current user has to the bucket containing this item. + + :return: The permissions of this ExtensionBundle. + :rtype: Permissions + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ExtensionBundle. + The access that the current user has to the bucket containing this item. + + :param permissions: The permissions of this ExtensionBundle. + :type: Permissions + """ + + self._permissions = permissions + + @property + def bundle_type(self): + """ + Gets the bundle_type of this ExtensionBundle. + The type of the extension bundle + + :return: The bundle_type of this ExtensionBundle. + :rtype: str + """ + return self._bundle_type + + @bundle_type.setter + def bundle_type(self, bundle_type): + """ + Sets the bundle_type of this ExtensionBundle. + The type of the extension bundle + + :param bundle_type: The bundle_type of this ExtensionBundle. + :type: str + """ + if bundle_type is None: + raise ValueError("Invalid value for `bundle_type`, must not be `None`") + allowed_values = ["NIFI_NAR", "MINIFI_CPP"] + if bundle_type not in allowed_values: + raise ValueError( + "Invalid value for `bundle_type` ({0}), must be one of {1}" + .format(bundle_type, allowed_values) + ) + + self._bundle_type = bundle_type + + @property + def group_id(self): + """ + Gets the group_id of this ExtensionBundle. + The group id of the extension bundle + + :return: The group_id of this ExtensionBundle. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ExtensionBundle. + The group id of the extension bundle + + :param group_id: The group_id of this ExtensionBundle. + :type: str + """ + + self._group_id = group_id + + @property + def artifact_id(self): + """ + Gets the artifact_id of this ExtensionBundle. + The artifact id of the extension bundle + + :return: The artifact_id of this ExtensionBundle. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this ExtensionBundle. + The artifact id of the extension bundle + + :param artifact_id: The artifact_id of this ExtensionBundle. + :type: str + """ + + self._artifact_id = artifact_id + + @property + def version_count(self): + """ + Gets the version_count of this ExtensionBundle. + The number of versions of this extension bundle. + + :return: The version_count of this ExtensionBundle. + :rtype: int + """ + return self._version_count + + @version_count.setter + def version_count(self, version_count): + """ + Sets the version_count of this ExtensionBundle. + The number of versions of this extension bundle. + + :param version_count: The version_count of this ExtensionBundle. + :type: int + """ + if version_count is not None and version_count < 0: + raise ValueError("Invalid value for `version_count`, must be a value greater than or equal to `0`") + + self._version_count = version_count + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionBundle): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_filter_params.py b/nipyapi/registry/models/extension_filter_params.py new file mode 100644 index 00000000..ad32f038 --- /dev/null +++ b/nipyapi/registry/models/extension_filter_params.py @@ -0,0 +1,193 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionFilterParams(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'bundle_type': 'str', + 'extension_type': 'str', + 'tags': 'list[str]' + } + + attribute_map = { + 'bundle_type': 'bundleType', + 'extension_type': 'extensionType', + 'tags': 'tags' + } + + def __init__(self, bundle_type=None, extension_type=None, tags=None): + """ + ExtensionFilterParams - a model defined in Swagger + """ + + self._bundle_type = None + self._extension_type = None + self._tags = None + + if bundle_type is not None: + self.bundle_type = bundle_type + if extension_type is not None: + self.extension_type = extension_type + if tags is not None: + self.tags = tags + + @property + def bundle_type(self): + """ + Gets the bundle_type of this ExtensionFilterParams. + The type of bundle + + :return: The bundle_type of this ExtensionFilterParams. + :rtype: str + """ + return self._bundle_type + + @bundle_type.setter + def bundle_type(self, bundle_type): + """ + Sets the bundle_type of this ExtensionFilterParams. + The type of bundle + + :param bundle_type: The bundle_type of this ExtensionFilterParams. + :type: str + """ + allowed_values = ["NIFI_NAR", "MINIFI_CPP"] + if bundle_type not in allowed_values: + raise ValueError( + "Invalid value for `bundle_type` ({0}), must be one of {1}" + .format(bundle_type, allowed_values) + ) + + self._bundle_type = bundle_type + + @property + def extension_type(self): + """ + Gets the extension_type of this ExtensionFilterParams. + The type of extension + + :return: The extension_type of this ExtensionFilterParams. + :rtype: str + """ + return self._extension_type + + @extension_type.setter + def extension_type(self, extension_type): + """ + Sets the extension_type of this ExtensionFilterParams. + The type of extension + + :param extension_type: The extension_type of this ExtensionFilterParams. + :type: str + """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK"] + if extension_type not in allowed_values: + raise ValueError( + "Invalid value for `extension_type` ({0}), must be one of {1}" + .format(extension_type, allowed_values) + ) + + self._extension_type = extension_type + + @property + def tags(self): + """ + Gets the tags of this ExtensionFilterParams. + The tags + + :return: The tags of this ExtensionFilterParams. + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """ + Sets the tags of this ExtensionFilterParams. + The tags + + :param tags: The tags of this ExtensionFilterParams. + :type: list[str] + """ + + self._tags = tags + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionFilterParams): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_metadata.py b/nipyapi/registry/models/extension_metadata.py new file mode 100644 index 00000000..e15a2cfa --- /dev/null +++ b/nipyapi/registry/models/extension_metadata.py @@ -0,0 +1,439 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionMetadata(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'name': 'str', + 'display_name': 'str', + 'type': 'str', + 'description': 'str', + 'deprecation_notice': 'DeprecationNotice', + 'tags': 'list[str]', + 'restricted': 'Restricted', + 'provided_service_ap_is': 'list[ProvidedServiceAPI]', + 'bundle_info': 'BundleInfo', + 'has_additional_details': 'bool', + 'link_docs': 'JaxbLink' + } + + attribute_map = { + 'link': 'link', + 'name': 'name', + 'display_name': 'displayName', + 'type': 'type', + 'description': 'description', + 'deprecation_notice': 'deprecationNotice', + 'tags': 'tags', + 'restricted': 'restricted', + 'provided_service_ap_is': 'providedServiceAPIs', + 'bundle_info': 'bundleInfo', + 'has_additional_details': 'hasAdditionalDetails', + 'link_docs': 'linkDocs' + } + + def __init__(self, link=None, name=None, display_name=None, type=None, description=None, deprecation_notice=None, tags=None, restricted=None, provided_service_ap_is=None, bundle_info=None, has_additional_details=None, link_docs=None): + """ + ExtensionMetadata - a model defined in Swagger + """ + + self._link = None + self._name = None + self._display_name = None + self._type = None + self._description = None + self._deprecation_notice = None + self._tags = None + self._restricted = None + self._provided_service_ap_is = None + self._bundle_info = None + self._has_additional_details = None + self._link_docs = None + + if link is not None: + self.link = link + if name is not None: + self.name = name + if display_name is not None: + self.display_name = display_name + if type is not None: + self.type = type + if description is not None: + self.description = description + if deprecation_notice is not None: + self.deprecation_notice = deprecation_notice + if tags is not None: + self.tags = tags + if restricted is not None: + self.restricted = restricted + if provided_service_ap_is is not None: + self.provided_service_ap_is = provided_service_ap_is + if bundle_info is not None: + self.bundle_info = bundle_info + if has_additional_details is not None: + self.has_additional_details = has_additional_details + if link_docs is not None: + self.link_docs = link_docs + + @property + def link(self): + """ + Gets the link of this ExtensionMetadata. + An WebLink to this entity. + + :return: The link of this ExtensionMetadata. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionMetadata. + An WebLink to this entity. + + :param link: The link of this ExtensionMetadata. + :type: JaxbLink + """ + + self._link = link + + @property + def name(self): + """ + Gets the name of this ExtensionMetadata. + The name of the extension + + :return: The name of this ExtensionMetadata. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ExtensionMetadata. + The name of the extension + + :param name: The name of this ExtensionMetadata. + :type: str + """ + + self._name = name + + @property + def display_name(self): + """ + Gets the display_name of this ExtensionMetadata. + The display name of the extension + + :return: The display_name of this ExtensionMetadata. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ExtensionMetadata. + The display name of the extension + + :param display_name: The display_name of this ExtensionMetadata. + :type: str + """ + + self._display_name = display_name + + @property + def type(self): + """ + Gets the type of this ExtensionMetadata. + The type of the extension + + :return: The type of this ExtensionMetadata. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this ExtensionMetadata. + The type of the extension + + :param type: The type of this ExtensionMetadata. + :type: str + """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK"] + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" + .format(type, allowed_values) + ) + + self._type = type + + @property + def description(self): + """ + Gets the description of this ExtensionMetadata. + The description of the extension + + :return: The description of this ExtensionMetadata. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ExtensionMetadata. + The description of the extension + + :param description: The description of this ExtensionMetadata. + :type: str + """ + + self._description = description + + @property + def deprecation_notice(self): + """ + Gets the deprecation_notice of this ExtensionMetadata. + The deprecation notice of the extension + + :return: The deprecation_notice of this ExtensionMetadata. + :rtype: DeprecationNotice + """ + return self._deprecation_notice + + @deprecation_notice.setter + def deprecation_notice(self, deprecation_notice): + """ + Sets the deprecation_notice of this ExtensionMetadata. + The deprecation notice of the extension + + :param deprecation_notice: The deprecation_notice of this ExtensionMetadata. + :type: DeprecationNotice + """ + + self._deprecation_notice = deprecation_notice + + @property + def tags(self): + """ + Gets the tags of this ExtensionMetadata. + The tags of the extension + + :return: The tags of this ExtensionMetadata. + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """ + Sets the tags of this ExtensionMetadata. + The tags of the extension + + :param tags: The tags of this ExtensionMetadata. + :type: list[str] + """ + + self._tags = tags + + @property + def restricted(self): + """ + Gets the restricted of this ExtensionMetadata. + The restrictions of the extension + + :return: The restricted of this ExtensionMetadata. + :rtype: Restricted + """ + return self._restricted + + @restricted.setter + def restricted(self, restricted): + """ + Sets the restricted of this ExtensionMetadata. + The restrictions of the extension + + :param restricted: The restricted of this ExtensionMetadata. + :type: Restricted + """ + + self._restricted = restricted + + @property + def provided_service_ap_is(self): + """ + Gets the provided_service_ap_is of this ExtensionMetadata. + The service APIs provided by the extension + + :return: The provided_service_ap_is of this ExtensionMetadata. + :rtype: list[ProvidedServiceAPI] + """ + return self._provided_service_ap_is + + @provided_service_ap_is.setter + def provided_service_ap_is(self, provided_service_ap_is): + """ + Sets the provided_service_ap_is of this ExtensionMetadata. + The service APIs provided by the extension + + :param provided_service_ap_is: The provided_service_ap_is of this ExtensionMetadata. + :type: list[ProvidedServiceAPI] + """ + + self._provided_service_ap_is = provided_service_ap_is + + @property + def bundle_info(self): + """ + Gets the bundle_info of this ExtensionMetadata. + The information for the bundle where this extension is located + + :return: The bundle_info of this ExtensionMetadata. + :rtype: BundleInfo + """ + return self._bundle_info + + @bundle_info.setter + def bundle_info(self, bundle_info): + """ + Sets the bundle_info of this ExtensionMetadata. + The information for the bundle where this extension is located + + :param bundle_info: The bundle_info of this ExtensionMetadata. + :type: BundleInfo + """ + + self._bundle_info = bundle_info + + @property + def has_additional_details(self): + """ + Gets the has_additional_details of this ExtensionMetadata. + Whether or not the extension has additional detail documentation + + :return: The has_additional_details of this ExtensionMetadata. + :rtype: bool + """ + return self._has_additional_details + + @has_additional_details.setter + def has_additional_details(self, has_additional_details): + """ + Sets the has_additional_details of this ExtensionMetadata. + Whether or not the extension has additional detail documentation + + :param has_additional_details: The has_additional_details of this ExtensionMetadata. + :type: bool + """ + + self._has_additional_details = has_additional_details + + @property + def link_docs(self): + """ + Gets the link_docs of this ExtensionMetadata. + A WebLink to the documentation for this extension. + + :return: The link_docs of this ExtensionMetadata. + :rtype: JaxbLink + """ + return self._link_docs + + @link_docs.setter + def link_docs(self, link_docs): + """ + Sets the link_docs of this ExtensionMetadata. + A WebLink to the documentation for this extension. + + :param link_docs: The link_docs of this ExtensionMetadata. + :type: JaxbLink + """ + + self._link_docs = link_docs + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionMetadata): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_metadata_container.py b/nipyapi/registry/models/extension_metadata_container.py new file mode 100644 index 00000000..ae7448be --- /dev/null +++ b/nipyapi/registry/models/extension_metadata_container.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionMetadataContainer(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'num_results': 'int', + 'filter_params': 'ExtensionFilterParams', + 'extensions': 'list[ExtensionMetadata]' + } + + attribute_map = { + 'num_results': 'numResults', + 'filter_params': 'filterParams', + 'extensions': 'extensions' + } + + def __init__(self, num_results=None, filter_params=None, extensions=None): + """ + ExtensionMetadataContainer - a model defined in Swagger + """ + + self._num_results = None + self._filter_params = None + self._extensions = None + + if num_results is not None: + self.num_results = num_results + if filter_params is not None: + self.filter_params = filter_params + if extensions is not None: + self.extensions = extensions + + @property + def num_results(self): + """ + Gets the num_results of this ExtensionMetadataContainer. + The number of extensions in the response + + :return: The num_results of this ExtensionMetadataContainer. + :rtype: int + """ + return self._num_results + + @num_results.setter + def num_results(self, num_results): + """ + Sets the num_results of this ExtensionMetadataContainer. + The number of extensions in the response + + :param num_results: The num_results of this ExtensionMetadataContainer. + :type: int + """ + + self._num_results = num_results + + @property + def filter_params(self): + """ + Gets the filter_params of this ExtensionMetadataContainer. + The filter parameters submitted for the request + + :return: The filter_params of this ExtensionMetadataContainer. + :rtype: ExtensionFilterParams + """ + return self._filter_params + + @filter_params.setter + def filter_params(self, filter_params): + """ + Sets the filter_params of this ExtensionMetadataContainer. + The filter parameters submitted for the request + + :param filter_params: The filter_params of this ExtensionMetadataContainer. + :type: ExtensionFilterParams + """ + + self._filter_params = filter_params + + @property + def extensions(self): + """ + Gets the extensions of this ExtensionMetadataContainer. + The metadata for the extensions + + :return: The extensions of this ExtensionMetadataContainer. + :rtype: list[ExtensionMetadata] + """ + return self._extensions + + @extensions.setter + def extensions(self, extensions): + """ + Sets the extensions of this ExtensionMetadataContainer. + The metadata for the extensions + + :param extensions: The extensions of this ExtensionMetadataContainer. + :type: list[ExtensionMetadata] + """ + + self._extensions = extensions + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionMetadataContainer): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_repo_artifact.py b/nipyapi/registry/models/extension_repo_artifact.py new file mode 100644 index 00000000..be75af9f --- /dev/null +++ b/nipyapi/registry/models/extension_repo_artifact.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionRepoArtifact(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'bucket_name': 'str', + 'group_id': 'str', + 'artifact_id': 'str' + } + + attribute_map = { + 'link': 'link', + 'bucket_name': 'bucketName', + 'group_id': 'groupId', + 'artifact_id': 'artifactId' + } + + def __init__(self, link=None, bucket_name=None, group_id=None, artifact_id=None): + """ + ExtensionRepoArtifact - a model defined in Swagger + """ + + self._link = None + self._bucket_name = None + self._group_id = None + self._artifact_id = None + + if link is not None: + self.link = link + if bucket_name is not None: + self.bucket_name = bucket_name + if group_id is not None: + self.group_id = group_id + if artifact_id is not None: + self.artifact_id = artifact_id + + @property + def link(self): + """ + Gets the link of this ExtensionRepoArtifact. + An WebLink to this entity. + + :return: The link of this ExtensionRepoArtifact. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionRepoArtifact. + An WebLink to this entity. + + :param link: The link of this ExtensionRepoArtifact. + :type: JaxbLink + """ + + self._link = link + + @property + def bucket_name(self): + """ + Gets the bucket_name of this ExtensionRepoArtifact. + The bucket name + + :return: The bucket_name of this ExtensionRepoArtifact. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this ExtensionRepoArtifact. + The bucket name + + :param bucket_name: The bucket_name of this ExtensionRepoArtifact. + :type: str + """ + + self._bucket_name = bucket_name + + @property + def group_id(self): + """ + Gets the group_id of this ExtensionRepoArtifact. + The group id + + :return: The group_id of this ExtensionRepoArtifact. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ExtensionRepoArtifact. + The group id + + :param group_id: The group_id of this ExtensionRepoArtifact. + :type: str + """ + + self._group_id = group_id + + @property + def artifact_id(self): + """ + Gets the artifact_id of this ExtensionRepoArtifact. + The artifact id + + :return: The artifact_id of this ExtensionRepoArtifact. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this ExtensionRepoArtifact. + The artifact id + + :param artifact_id: The artifact_id of this ExtensionRepoArtifact. + :type: str + """ + + self._artifact_id = artifact_id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionRepoArtifact): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_repo_bucket.py b/nipyapi/registry/models/extension_repo_bucket.py new file mode 100644 index 00000000..265596a3 --- /dev/null +++ b/nipyapi/registry/models/extension_repo_bucket.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionRepoBucket(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'bucket_name': 'str' + } + + attribute_map = { + 'link': 'link', + 'bucket_name': 'bucketName' + } + + def __init__(self, link=None, bucket_name=None): + """ + ExtensionRepoBucket - a model defined in Swagger + """ + + self._link = None + self._bucket_name = None + + if link is not None: + self.link = link + if bucket_name is not None: + self.bucket_name = bucket_name + + @property + def link(self): + """ + Gets the link of this ExtensionRepoBucket. + An WebLink to this entity. + + :return: The link of this ExtensionRepoBucket. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionRepoBucket. + An WebLink to this entity. + + :param link: The link of this ExtensionRepoBucket. + :type: JaxbLink + """ + + self._link = link + + @property + def bucket_name(self): + """ + Gets the bucket_name of this ExtensionRepoBucket. + The name of the bucket + + :return: The bucket_name of this ExtensionRepoBucket. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this ExtensionRepoBucket. + The name of the bucket + + :param bucket_name: The bucket_name of this ExtensionRepoBucket. + :type: str + """ + + self._bucket_name = bucket_name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionRepoBucket): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_repo_group.py b/nipyapi/registry/models/extension_repo_group.py new file mode 100644 index 00000000..97f05db6 --- /dev/null +++ b/nipyapi/registry/models/extension_repo_group.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionRepoGroup(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'bucket_name': 'str', + 'group_id': 'str' + } + + attribute_map = { + 'link': 'link', + 'bucket_name': 'bucketName', + 'group_id': 'groupId' + } + + def __init__(self, link=None, bucket_name=None, group_id=None): + """ + ExtensionRepoGroup - a model defined in Swagger + """ + + self._link = None + self._bucket_name = None + self._group_id = None + + if link is not None: + self.link = link + if bucket_name is not None: + self.bucket_name = bucket_name + if group_id is not None: + self.group_id = group_id + + @property + def link(self): + """ + Gets the link of this ExtensionRepoGroup. + An WebLink to this entity. + + :return: The link of this ExtensionRepoGroup. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionRepoGroup. + An WebLink to this entity. + + :param link: The link of this ExtensionRepoGroup. + :type: JaxbLink + """ + + self._link = link + + @property + def bucket_name(self): + """ + Gets the bucket_name of this ExtensionRepoGroup. + The bucket name + + :return: The bucket_name of this ExtensionRepoGroup. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this ExtensionRepoGroup. + The bucket name + + :param bucket_name: The bucket_name of this ExtensionRepoGroup. + :type: str + """ + + self._bucket_name = bucket_name + + @property + def group_id(self): + """ + Gets the group_id of this ExtensionRepoGroup. + The group id + + :return: The group_id of this ExtensionRepoGroup. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ExtensionRepoGroup. + The group id + + :param group_id: The group_id of this ExtensionRepoGroup. + :type: str + """ + + self._group_id = group_id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionRepoGroup): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_repo_version.py b/nipyapi/registry/models/extension_repo_version.py new file mode 100644 index 00000000..6307a86d --- /dev/null +++ b/nipyapi/registry/models/extension_repo_version.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionRepoVersion(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'extensions_link': 'JaxbLink', + 'download_link': 'JaxbLink', + 'sha256_link': 'JaxbLink', + 'sha256_supplied': 'JaxbLink' + } + + attribute_map = { + 'extensions_link': 'extensionsLink', + 'download_link': 'downloadLink', + 'sha256_link': 'sha256Link', + 'sha256_supplied': 'sha256Supplied' + } + + def __init__(self, extensions_link=None, download_link=None, sha256_link=None, sha256_supplied=None): + """ + ExtensionRepoVersion - a model defined in Swagger + """ + + self._extensions_link = None + self._download_link = None + self._sha256_link = None + self._sha256_supplied = None + + if extensions_link is not None: + self.extensions_link = extensions_link + if download_link is not None: + self.download_link = download_link + if sha256_link is not None: + self.sha256_link = sha256_link + if sha256_supplied is not None: + self.sha256_supplied = sha256_supplied + + @property + def extensions_link(self): + """ + Gets the extensions_link of this ExtensionRepoVersion. + The WebLink to view the metadata about the extensions contained in the extension bundle. + + :return: The extensions_link of this ExtensionRepoVersion. + :rtype: JaxbLink + """ + return self._extensions_link + + @extensions_link.setter + def extensions_link(self, extensions_link): + """ + Sets the extensions_link of this ExtensionRepoVersion. + The WebLink to view the metadata about the extensions contained in the extension bundle. + + :param extensions_link: The extensions_link of this ExtensionRepoVersion. + :type: JaxbLink + """ + + self._extensions_link = extensions_link + + @property + def download_link(self): + """ + Gets the download_link of this ExtensionRepoVersion. + The WebLink to download this version of the extension bundle. + + :return: The download_link of this ExtensionRepoVersion. + :rtype: JaxbLink + """ + return self._download_link + + @download_link.setter + def download_link(self, download_link): + """ + Sets the download_link of this ExtensionRepoVersion. + The WebLink to download this version of the extension bundle. + + :param download_link: The download_link of this ExtensionRepoVersion. + :type: JaxbLink + """ + + self._download_link = download_link + + @property + def sha256_link(self): + """ + Gets the sha256_link of this ExtensionRepoVersion. + The WebLink to retrieve the SHA-256 digest for this version of the extension bundle. + + :return: The sha256_link of this ExtensionRepoVersion. + :rtype: JaxbLink + """ + return self._sha256_link + + @sha256_link.setter + def sha256_link(self, sha256_link): + """ + Sets the sha256_link of this ExtensionRepoVersion. + The WebLink to retrieve the SHA-256 digest for this version of the extension bundle. + + :param sha256_link: The sha256_link of this ExtensionRepoVersion. + :type: JaxbLink + """ + + self._sha256_link = sha256_link + + @property + def sha256_supplied(self): + """ + Gets the sha256_supplied of this ExtensionRepoVersion. + Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle. + + :return: The sha256_supplied of this ExtensionRepoVersion. + :rtype: JaxbLink + """ + return self._sha256_supplied + + @sha256_supplied.setter + def sha256_supplied(self, sha256_supplied): + """ + Sets the sha256_supplied of this ExtensionRepoVersion. + Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle. + + :param sha256_supplied: The sha256_supplied of this ExtensionRepoVersion. + :type: JaxbLink + """ + + self._sha256_supplied = sha256_supplied + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionRepoVersion): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/extension_repo_version_summary.py b/nipyapi/registry/models/extension_repo_version_summary.py new file mode 100644 index 00000000..19ca56af --- /dev/null +++ b/nipyapi/registry/models/extension_repo_version_summary.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExtensionRepoVersionSummary(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'link': 'JaxbLink', + 'bucket_name': 'str', + 'group_id': 'str', + 'artifact_id': 'str', + 'version': 'str', + 'author': 'str', + 'timestamp': 'int' + } + + attribute_map = { + 'link': 'link', + 'bucket_name': 'bucketName', + 'group_id': 'groupId', + 'artifact_id': 'artifactId', + 'version': 'version', + 'author': 'author', + 'timestamp': 'timestamp' + } + + def __init__(self, link=None, bucket_name=None, group_id=None, artifact_id=None, version=None, author=None, timestamp=None): + """ + ExtensionRepoVersionSummary - a model defined in Swagger + """ + + self._link = None + self._bucket_name = None + self._group_id = None + self._artifact_id = None + self._version = None + self._author = None + self._timestamp = None + + if link is not None: + self.link = link + if bucket_name is not None: + self.bucket_name = bucket_name + if group_id is not None: + self.group_id = group_id + if artifact_id is not None: + self.artifact_id = artifact_id + if version is not None: + self.version = version + if author is not None: + self.author = author + if timestamp is not None: + self.timestamp = timestamp + + @property + def link(self): + """ + Gets the link of this ExtensionRepoVersionSummary. + An WebLink to this entity. + + :return: The link of this ExtensionRepoVersionSummary. + :rtype: JaxbLink + """ + return self._link + + @link.setter + def link(self, link): + """ + Sets the link of this ExtensionRepoVersionSummary. + An WebLink to this entity. + + :param link: The link of this ExtensionRepoVersionSummary. + :type: JaxbLink + """ + + self._link = link + + @property + def bucket_name(self): + """ + Gets the bucket_name of this ExtensionRepoVersionSummary. + The bucket name + + :return: The bucket_name of this ExtensionRepoVersionSummary. + :rtype: str + """ + return self._bucket_name + + @bucket_name.setter + def bucket_name(self, bucket_name): + """ + Sets the bucket_name of this ExtensionRepoVersionSummary. + The bucket name + + :param bucket_name: The bucket_name of this ExtensionRepoVersionSummary. + :type: str + """ + + self._bucket_name = bucket_name + + @property + def group_id(self): + """ + Gets the group_id of this ExtensionRepoVersionSummary. + The group id + + :return: The group_id of this ExtensionRepoVersionSummary. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ExtensionRepoVersionSummary. + The group id + + :param group_id: The group_id of this ExtensionRepoVersionSummary. + :type: str + """ + + self._group_id = group_id + + @property + def artifact_id(self): + """ + Gets the artifact_id of this ExtensionRepoVersionSummary. + The artifact id + + :return: The artifact_id of this ExtensionRepoVersionSummary. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this ExtensionRepoVersionSummary. + The artifact id + + :param artifact_id: The artifact_id of this ExtensionRepoVersionSummary. + :type: str + """ + + self._artifact_id = artifact_id + + @property + def version(self): + """ + Gets the version of this ExtensionRepoVersionSummary. + The version + + :return: The version of this ExtensionRepoVersionSummary. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this ExtensionRepoVersionSummary. + The version + + :param version: The version of this ExtensionRepoVersionSummary. + :type: str + """ + + self._version = version + + @property + def author(self): + """ + Gets the author of this ExtensionRepoVersionSummary. + The identity of the user that created this version + + :return: The author of this ExtensionRepoVersionSummary. + :rtype: str + """ + return self._author + + @author.setter + def author(self, author): + """ + Sets the author of this ExtensionRepoVersionSummary. + The identity of the user that created this version + + :param author: The author of this ExtensionRepoVersionSummary. + :type: str + """ + + self._author = author + + @property + def timestamp(self): + """ + Gets the timestamp of this ExtensionRepoVersionSummary. + The timestamp of when this version was created + + :return: The timestamp of this ExtensionRepoVersionSummary. + :rtype: int + """ + return self._timestamp + + @timestamp.setter + def timestamp(self, timestamp): + """ + Sets the timestamp of this ExtensionRepoVersionSummary. + The timestamp of when this version was created + + :param timestamp: The timestamp of this ExtensionRepoVersionSummary. + :type: int + """ + + self._timestamp = timestamp + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExtensionRepoVersionSummary): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/external_controller_service_reference.py b/nipyapi/registry/models/external_controller_service_reference.py new file mode 100644 index 00000000..0a15fe35 --- /dev/null +++ b/nipyapi/registry/models/external_controller_service_reference.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExternalControllerServiceReference(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'identifier': 'str', + 'name': 'str' + } + + attribute_map = { + 'identifier': 'identifier', + 'name': 'name' + } + + def __init__(self, identifier=None, name=None): + """ + ExternalControllerServiceReference - a model defined in Swagger + """ + + self._identifier = None + self._name = None + + if identifier is not None: + self.identifier = identifier + if name is not None: + self.name = name + + @property + def identifier(self): + """ + Gets the identifier of this ExternalControllerServiceReference. + The identifier of the controller service + + :return: The identifier of this ExternalControllerServiceReference. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ExternalControllerServiceReference. + The identifier of the controller service + + :param identifier: The identifier of this ExternalControllerServiceReference. + :type: str + """ + + self._identifier = identifier + + @property + def name(self): + """ + Gets the name of this ExternalControllerServiceReference. + The name of the controller service + + :return: The name of this ExternalControllerServiceReference. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ExternalControllerServiceReference. + The name of the controller service + + :param name: The name of this ExternalControllerServiceReference. + :type: str + """ + + self._name = name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExternalControllerServiceReference): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/fields.py b/nipyapi/registry/models/fields.py index b562d51a..0368a86d 100644 --- a/nipyapi/registry/models/fields.py +++ b/nipyapi/registry/models/fields.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/jaxb_link.py b/nipyapi/registry/models/jaxb_link.py new file mode 100644 index 00000000..6e42823e --- /dev/null +++ b/nipyapi/registry/models/jaxb_link.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class JaxbLink(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'href': 'str', + 'params': 'dict(str, str)' + } + + attribute_map = { + 'href': 'href', + 'params': 'params' + } + + def __init__(self, href=None, params=None): + """ + JaxbLink - a model defined in Swagger + """ + + self._href = None + self._params = None + + if href is not None: + self.href = href + if params is not None: + self.params = params + + @property + def href(self): + """ + Gets the href of this JaxbLink. + The href for the link + + :return: The href of this JaxbLink. + :rtype: str + """ + return self._href + + @href.setter + def href(self, href): + """ + Sets the href of this JaxbLink. + The href for the link + + :param href: The href of this JaxbLink. + :type: str + """ + + self._href = href + + @property + def params(self): + """ + Gets the params of this JaxbLink. + The params for the link + + :return: The params of this JaxbLink. + :rtype: dict(str, str) + """ + return self._params + + @params.setter + def params(self, params): + """ + Sets the params of this JaxbLink. + The params for the link + + :param params: The params of this JaxbLink. + :type: dict(str, str) + """ + + self._params = params + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, JaxbLink): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/link.py b/nipyapi/registry/models/link.py deleted file mode 100644 index 8049b5b5..00000000 --- a/nipyapi/registry/models/link.py +++ /dev/null @@ -1,279 +0,0 @@ -# coding: utf-8 - -""" - NiFi Registry REST API - - The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - - OUTPUTOpenAPI spec version: 0.3.0 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -from six import iteritems -import re - - -class Link(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'type': 'str', - 'rels': 'list[str]', - 'title': 'str', - 'params': 'dict(str, str)', - 'uri': 'str', - 'uri_builder': 'UriBuilder', - 'rel': 'str' - } - - attribute_map = { - 'type': 'type', - 'rels': 'rels', - 'title': 'title', - 'params': 'params', - 'uri': 'uri', - 'uri_builder': 'uriBuilder', - 'rel': 'rel' - } - - def __init__(self, type=None, rels=None, title=None, params=None, uri=None, uri_builder=None, rel=None): - """ - Link - a model defined in Swagger - """ - - self._type = None - self._rels = None - self._title = None - self._params = None - self._uri = None - self._uri_builder = None - self._rel = None - - if type is not None: - self.type = type - if rels is not None: - self.rels = rels - if title is not None: - self.title = title - if params is not None: - self.params = params - if uri is not None: - self.uri = uri - if uri_builder is not None: - self.uri_builder = uri_builder - if rel is not None: - self.rel = rel - - @property - def type(self): - """ - Gets the type of this Link. - - :return: The type of this Link. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this Link. - - :param type: The type of this Link. - :type: str - """ - - self._type = type - - @property - def rels(self): - """ - Gets the rels of this Link. - - :return: The rels of this Link. - :rtype: list[str] - """ - return self._rels - - @rels.setter - def rels(self, rels): - """ - Sets the rels of this Link. - - :param rels: The rels of this Link. - :type: list[str] - """ - - self._rels = rels - - @property - def title(self): - """ - Gets the title of this Link. - - :return: The title of this Link. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this Link. - - :param title: The title of this Link. - :type: str - """ - - self._title = title - - @property - def params(self): - """ - Gets the params of this Link. - - :return: The params of this Link. - :rtype: dict(str, str) - """ - return self._params - - @params.setter - def params(self, params): - """ - Sets the params of this Link. - - :param params: The params of this Link. - :type: dict(str, str) - """ - - self._params = params - - @property - def uri(self): - """ - Gets the uri of this Link. - - :return: The uri of this Link. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this Link. - - :param uri: The uri of this Link. - :type: str - """ - - self._uri = uri - - @property - def uri_builder(self): - """ - Gets the uri_builder of this Link. - - :return: The uri_builder of this Link. - :rtype: UriBuilder - """ - return self._uri_builder - - @uri_builder.setter - def uri_builder(self, uri_builder): - """ - Sets the uri_builder of this Link. - - :param uri_builder: The uri_builder of this Link. - :type: UriBuilder - """ - - self._uri_builder = uri_builder - - @property - def rel(self): - """ - Gets the rel of this Link. - - :return: The rel of this Link. - :rtype: str - """ - return self._rel - - @rel.setter - def rel(self, rel): - """ - Sets the rel of this Link. - - :param rel: The rel of this Link. - :type: str - """ - - self._rel = rel - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - if not isinstance(other, Link): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/registry/models/model_property.py b/nipyapi/registry/models/model_property.py new file mode 100644 index 00000000..b803f124 --- /dev/null +++ b/nipyapi/registry/models/model_property.py @@ -0,0 +1,439 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ModelProperty(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'display_name': 'str', + 'description': 'str', + 'default_value': 'str', + 'controller_service_definition': 'ControllerServiceDefinition', + 'allowable_values': 'list[AllowableValue]', + 'required': 'bool', + 'sensitive': 'bool', + 'expression_language_supported': 'bool', + 'expression_language_scope': 'str', + 'dynamically_modifies_classpath': 'bool', + 'dynamic': 'bool' + } + + attribute_map = { + 'name': 'name', + 'display_name': 'displayName', + 'description': 'description', + 'default_value': 'defaultValue', + 'controller_service_definition': 'controllerServiceDefinition', + 'allowable_values': 'allowableValues', + 'required': 'required', + 'sensitive': 'sensitive', + 'expression_language_supported': 'expressionLanguageSupported', + 'expression_language_scope': 'expressionLanguageScope', + 'dynamically_modifies_classpath': 'dynamicallyModifiesClasspath', + 'dynamic': 'dynamic' + } + + def __init__(self, name=None, display_name=None, description=None, default_value=None, controller_service_definition=None, allowable_values=None, required=None, sensitive=None, expression_language_supported=None, expression_language_scope=None, dynamically_modifies_classpath=None, dynamic=None): + """ + ModelProperty - a model defined in Swagger + """ + + self._name = None + self._display_name = None + self._description = None + self._default_value = None + self._controller_service_definition = None + self._allowable_values = None + self._required = None + self._sensitive = None + self._expression_language_supported = None + self._expression_language_scope = None + self._dynamically_modifies_classpath = None + self._dynamic = None + + if name is not None: + self.name = name + if display_name is not None: + self.display_name = display_name + if description is not None: + self.description = description + if default_value is not None: + self.default_value = default_value + if controller_service_definition is not None: + self.controller_service_definition = controller_service_definition + if allowable_values is not None: + self.allowable_values = allowable_values + if required is not None: + self.required = required + if sensitive is not None: + self.sensitive = sensitive + if expression_language_supported is not None: + self.expression_language_supported = expression_language_supported + if expression_language_scope is not None: + self.expression_language_scope = expression_language_scope + if dynamically_modifies_classpath is not None: + self.dynamically_modifies_classpath = dynamically_modifies_classpath + if dynamic is not None: + self.dynamic = dynamic + + @property + def name(self): + """ + Gets the name of this ModelProperty. + The name of the property + + :return: The name of this ModelProperty. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ModelProperty. + The name of the property + + :param name: The name of this ModelProperty. + :type: str + """ + + self._name = name + + @property + def display_name(self): + """ + Gets the display_name of this ModelProperty. + The display name + + :return: The display_name of this ModelProperty. + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """ + Sets the display_name of this ModelProperty. + The display name + + :param display_name: The display_name of this ModelProperty. + :type: str + """ + + self._display_name = display_name + + @property + def description(self): + """ + Gets the description of this ModelProperty. + The description + + :return: The description of this ModelProperty. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ModelProperty. + The description + + :param description: The description of this ModelProperty. + :type: str + """ + + self._description = description + + @property + def default_value(self): + """ + Gets the default_value of this ModelProperty. + The default value + + :return: The default_value of this ModelProperty. + :rtype: str + """ + return self._default_value + + @default_value.setter + def default_value(self, default_value): + """ + Sets the default_value of this ModelProperty. + The default value + + :param default_value: The default_value of this ModelProperty. + :type: str + """ + + self._default_value = default_value + + @property + def controller_service_definition(self): + """ + Gets the controller_service_definition of this ModelProperty. + The controller service required by this property, or null if none is required + + :return: The controller_service_definition of this ModelProperty. + :rtype: ControllerServiceDefinition + """ + return self._controller_service_definition + + @controller_service_definition.setter + def controller_service_definition(self, controller_service_definition): + """ + Sets the controller_service_definition of this ModelProperty. + The controller service required by this property, or null if none is required + + :param controller_service_definition: The controller_service_definition of this ModelProperty. + :type: ControllerServiceDefinition + """ + + self._controller_service_definition = controller_service_definition + + @property + def allowable_values(self): + """ + Gets the allowable_values of this ModelProperty. + The allowable values for this property + + :return: The allowable_values of this ModelProperty. + :rtype: list[AllowableValue] + """ + return self._allowable_values + + @allowable_values.setter + def allowable_values(self, allowable_values): + """ + Sets the allowable_values of this ModelProperty. + The allowable values for this property + + :param allowable_values: The allowable_values of this ModelProperty. + :type: list[AllowableValue] + """ + + self._allowable_values = allowable_values + + @property + def required(self): + """ + Gets the required of this ModelProperty. + Whether or not the property is required + + :return: The required of this ModelProperty. + :rtype: bool + """ + return self._required + + @required.setter + def required(self, required): + """ + Sets the required of this ModelProperty. + Whether or not the property is required + + :param required: The required of this ModelProperty. + :type: bool + """ + + self._required = required + + @property + def sensitive(self): + """ + Gets the sensitive of this ModelProperty. + Whether or not the property is sensitive + + :return: The sensitive of this ModelProperty. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this ModelProperty. + Whether or not the property is sensitive + + :param sensitive: The sensitive of this ModelProperty. + :type: bool + """ + + self._sensitive = sensitive + + @property + def expression_language_supported(self): + """ + Gets the expression_language_supported of this ModelProperty. + Whether or not expression language is supported + + :return: The expression_language_supported of this ModelProperty. + :rtype: bool + """ + return self._expression_language_supported + + @expression_language_supported.setter + def expression_language_supported(self, expression_language_supported): + """ + Sets the expression_language_supported of this ModelProperty. + Whether or not expression language is supported + + :param expression_language_supported: The expression_language_supported of this ModelProperty. + :type: bool + """ + + self._expression_language_supported = expression_language_supported + + @property + def expression_language_scope(self): + """ + Gets the expression_language_scope of this ModelProperty. + The scope of expression language support + + :return: The expression_language_scope of this ModelProperty. + :rtype: str + """ + return self._expression_language_scope + + @expression_language_scope.setter + def expression_language_scope(self, expression_language_scope): + """ + Sets the expression_language_scope of this ModelProperty. + The scope of expression language support + + :param expression_language_scope: The expression_language_scope of this ModelProperty. + :type: str + """ + allowed_values = ["NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES"] + if expression_language_scope not in allowed_values: + raise ValueError( + "Invalid value for `expression_language_scope` ({0}), must be one of {1}" + .format(expression_language_scope, allowed_values) + ) + + self._expression_language_scope = expression_language_scope + + @property + def dynamically_modifies_classpath(self): + """ + Gets the dynamically_modifies_classpath of this ModelProperty. + Whether or not the processor dynamically modifies the classpath + + :return: The dynamically_modifies_classpath of this ModelProperty. + :rtype: bool + """ + return self._dynamically_modifies_classpath + + @dynamically_modifies_classpath.setter + def dynamically_modifies_classpath(self, dynamically_modifies_classpath): + """ + Sets the dynamically_modifies_classpath of this ModelProperty. + Whether or not the processor dynamically modifies the classpath + + :param dynamically_modifies_classpath: The dynamically_modifies_classpath of this ModelProperty. + :type: bool + """ + + self._dynamically_modifies_classpath = dynamically_modifies_classpath + + @property + def dynamic(self): + """ + Gets the dynamic of this ModelProperty. + Whether or not the processor is dynamic + + :return: The dynamic of this ModelProperty. + :rtype: bool + """ + return self._dynamic + + @dynamic.setter + def dynamic(self, dynamic): + """ + Sets the dynamic of this ModelProperty. + Whether or not the processor is dynamic + + :param dynamic: The dynamic of this ModelProperty. + :type: bool + """ + + self._dynamic = dynamic + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ModelProperty): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/permissions.py b/nipyapi/registry/models/permissions.py index 287ba909..5fcc366d 100644 --- a/nipyapi/registry/models/permissions.py +++ b/nipyapi/registry/models/permissions.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/position.py b/nipyapi/registry/models/position.py index 4b84cbb4..64d4f71d 100644 --- a/nipyapi/registry/models/position.py +++ b/nipyapi/registry/models/position.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/provided_service_api.py b/nipyapi/registry/models/provided_service_api.py new file mode 100644 index 00000000..4809d6fe --- /dev/null +++ b/nipyapi/registry/models/provided_service_api.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProvidedServiceAPI(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'class_name': 'str', + 'group_id': 'str', + 'artifact_id': 'str', + 'version': 'str' + } + + attribute_map = { + 'class_name': 'className', + 'group_id': 'groupId', + 'artifact_id': 'artifactId', + 'version': 'version' + } + + def __init__(self, class_name=None, group_id=None, artifact_id=None, version=None): + """ + ProvidedServiceAPI - a model defined in Swagger + """ + + self._class_name = None + self._group_id = None + self._artifact_id = None + self._version = None + + if class_name is not None: + self.class_name = class_name + if group_id is not None: + self.group_id = group_id + if artifact_id is not None: + self.artifact_id = artifact_id + if version is not None: + self.version = version + + @property + def class_name(self): + """ + Gets the class_name of this ProvidedServiceAPI. + The class name of the service API being provided + + :return: The class_name of this ProvidedServiceAPI. + :rtype: str + """ + return self._class_name + + @class_name.setter + def class_name(self, class_name): + """ + Sets the class_name of this ProvidedServiceAPI. + The class name of the service API being provided + + :param class_name: The class_name of this ProvidedServiceAPI. + :type: str + """ + + self._class_name = class_name + + @property + def group_id(self): + """ + Gets the group_id of this ProvidedServiceAPI. + The group id of the service API being provided + + :return: The group_id of this ProvidedServiceAPI. + :rtype: str + """ + return self._group_id + + @group_id.setter + def group_id(self, group_id): + """ + Sets the group_id of this ProvidedServiceAPI. + The group id of the service API being provided + + :param group_id: The group_id of this ProvidedServiceAPI. + :type: str + """ + + self._group_id = group_id + + @property + def artifact_id(self): + """ + Gets the artifact_id of this ProvidedServiceAPI. + The artifact id of the service API being provided + + :return: The artifact_id of this ProvidedServiceAPI. + :rtype: str + """ + return self._artifact_id + + @artifact_id.setter + def artifact_id(self, artifact_id): + """ + Sets the artifact_id of this ProvidedServiceAPI. + The artifact id of the service API being provided + + :param artifact_id: The artifact_id of this ProvidedServiceAPI. + :type: str + """ + + self._artifact_id = artifact_id + + @property + def version(self): + """ + Gets the version of this ProvidedServiceAPI. + The version of the service API being provided + + :return: The version of this ProvidedServiceAPI. + :rtype: str + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this ProvidedServiceAPI. + The version of the service API being provided + + :param version: The version of this ProvidedServiceAPI. + :type: str + """ + + self._version = version + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProvidedServiceAPI): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/registry_configuration.py b/nipyapi/registry/models/registry_configuration.py new file mode 100644 index 00000000..ec57a0e9 --- /dev/null +++ b/nipyapi/registry/models/registry_configuration.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class RegistryConfiguration(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'supports_managed_authorizer': 'bool', + 'supports_configurable_authorizer': 'bool', + 'supports_configurable_users_and_groups': 'bool' + } + + attribute_map = { + 'supports_managed_authorizer': 'supportsManagedAuthorizer', + 'supports_configurable_authorizer': 'supportsConfigurableAuthorizer', + 'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups' + } + + def __init__(self, supports_managed_authorizer=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None): + """ + RegistryConfiguration - a model defined in Swagger + """ + + self._supports_managed_authorizer = None + self._supports_configurable_authorizer = None + self._supports_configurable_users_and_groups = None + + if supports_managed_authorizer is not None: + self.supports_managed_authorizer = supports_managed_authorizer + if supports_configurable_authorizer is not None: + self.supports_configurable_authorizer = supports_configurable_authorizer + if supports_configurable_users_and_groups is not None: + self.supports_configurable_users_and_groups = supports_configurable_users_and_groups + + @property + def supports_managed_authorizer(self): + """ + Gets the supports_managed_authorizer of this RegistryConfiguration. + Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. + + :return: The supports_managed_authorizer of this RegistryConfiguration. + :rtype: bool + """ + return self._supports_managed_authorizer + + @supports_managed_authorizer.setter + def supports_managed_authorizer(self, supports_managed_authorizer): + """ + Sets the supports_managed_authorizer of this RegistryConfiguration. + Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. + + :param supports_managed_authorizer: The supports_managed_authorizer of this RegistryConfiguration. + :type: bool + """ + + self._supports_managed_authorizer = supports_managed_authorizer + + @property + def supports_configurable_authorizer(self): + """ + Gets the supports_configurable_authorizer of this RegistryConfiguration. + Whether this NiFi Registry supports a configurable authorizer. + + :return: The supports_configurable_authorizer of this RegistryConfiguration. + :rtype: bool + """ + return self._supports_configurable_authorizer + + @supports_configurable_authorizer.setter + def supports_configurable_authorizer(self, supports_configurable_authorizer): + """ + Sets the supports_configurable_authorizer of this RegistryConfiguration. + Whether this NiFi Registry supports a configurable authorizer. + + :param supports_configurable_authorizer: The supports_configurable_authorizer of this RegistryConfiguration. + :type: bool + """ + + self._supports_configurable_authorizer = supports_configurable_authorizer + + @property + def supports_configurable_users_and_groups(self): + """ + Gets the supports_configurable_users_and_groups of this RegistryConfiguration. + Whether this NiFi Registry supports configurable users and groups. + + :return: The supports_configurable_users_and_groups of this RegistryConfiguration. + :rtype: bool + """ + return self._supports_configurable_users_and_groups + + @supports_configurable_users_and_groups.setter + def supports_configurable_users_and_groups(self, supports_configurable_users_and_groups): + """ + Sets the supports_configurable_users_and_groups of this RegistryConfiguration. + Whether this NiFi Registry supports configurable users and groups. + + :param supports_configurable_users_and_groups: The supports_configurable_users_and_groups of this RegistryConfiguration. + :type: bool + """ + + self._supports_configurable_users_and_groups = supports_configurable_users_and_groups + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, RegistryConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/relationship.py b/nipyapi/registry/models/relationship.py new file mode 100644 index 00000000..f8063d28 --- /dev/null +++ b/nipyapi/registry/models/relationship.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class Relationship(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'auto_terminated': 'bool' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'auto_terminated': 'autoTerminated' + } + + def __init__(self, name=None, description=None, auto_terminated=None): + """ + Relationship - a model defined in Swagger + """ + + self._name = None + self._description = None + self._auto_terminated = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if auto_terminated is not None: + self.auto_terminated = auto_terminated + + @property + def name(self): + """ + Gets the name of this Relationship. + The name of the relationship + + :return: The name of this Relationship. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this Relationship. + The name of the relationship + + :param name: The name of this Relationship. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this Relationship. + The description of the relationship + + :return: The description of this Relationship. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Relationship. + The description of the relationship + + :param description: The description of this Relationship. + :type: str + """ + + self._description = description + + @property + def auto_terminated(self): + """ + Gets the auto_terminated of this Relationship. + Whether or not the relationship is auto-terminated by default + + :return: The auto_terminated of this Relationship. + :rtype: bool + """ + return self._auto_terminated + + @auto_terminated.setter + def auto_terminated(self, auto_terminated): + """ + Sets the auto_terminated of this Relationship. + Whether or not the relationship is auto-terminated by default + + :param auto_terminated: The auto_terminated of this Relationship. + :type: bool + """ + + self._auto_terminated = auto_terminated + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Relationship): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/resource.py b/nipyapi/registry/models/resource.py index b8f90c1d..06f6e717 100644 --- a/nipyapi/registry/models/resource.py +++ b/nipyapi/registry/models/resource.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/resource_permissions.py b/nipyapi/registry/models/resource_permissions.py index 0e7af022..95119242 100644 --- a/nipyapi/registry/models/resource_permissions.py +++ b/nipyapi/registry/models/resource_permissions.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/restricted.py b/nipyapi/registry/models/restricted.py new file mode 100644 index 00000000..f3418b9e --- /dev/null +++ b/nipyapi/registry/models/restricted.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class Restricted(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'general_restriction_explanation': 'str', + 'restrictions': 'list[Restriction]' + } + + attribute_map = { + 'general_restriction_explanation': 'generalRestrictionExplanation', + 'restrictions': 'restrictions' + } + + def __init__(self, general_restriction_explanation=None, restrictions=None): + """ + Restricted - a model defined in Swagger + """ + + self._general_restriction_explanation = None + self._restrictions = None + + if general_restriction_explanation is not None: + self.general_restriction_explanation = general_restriction_explanation + if restrictions is not None: + self.restrictions = restrictions + + @property + def general_restriction_explanation(self): + """ + Gets the general_restriction_explanation of this Restricted. + The general restriction for the extension, or null if only specific restrictions exist + + :return: The general_restriction_explanation of this Restricted. + :rtype: str + """ + return self._general_restriction_explanation + + @general_restriction_explanation.setter + def general_restriction_explanation(self, general_restriction_explanation): + """ + Sets the general_restriction_explanation of this Restricted. + The general restriction for the extension, or null if only specific restrictions exist + + :param general_restriction_explanation: The general_restriction_explanation of this Restricted. + :type: str + """ + + self._general_restriction_explanation = general_restriction_explanation + + @property + def restrictions(self): + """ + Gets the restrictions of this Restricted. + The specific restrictions + + :return: The restrictions of this Restricted. + :rtype: list[Restriction] + """ + return self._restrictions + + @restrictions.setter + def restrictions(self, restrictions): + """ + Sets the restrictions of this Restricted. + The specific restrictions + + :param restrictions: The restrictions of this Restricted. + :type: list[Restriction] + """ + + self._restrictions = restrictions + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Restricted): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/restriction.py b/nipyapi/registry/models/restriction.py new file mode 100644 index 00000000..fbf3b691 --- /dev/null +++ b/nipyapi/registry/models/restriction.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class Restriction(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'required_permission': 'str', + 'explanation': 'str' + } + + attribute_map = { + 'required_permission': 'requiredPermission', + 'explanation': 'explanation' + } + + def __init__(self, required_permission=None, explanation=None): + """ + Restriction - a model defined in Swagger + """ + + self._required_permission = None + self._explanation = None + + if required_permission is not None: + self.required_permission = required_permission + if explanation is not None: + self.explanation = explanation + + @property + def required_permission(self): + """ + Gets the required_permission of this Restriction. + The permission required for this restriction + + :return: The required_permission of this Restriction. + :rtype: str + """ + return self._required_permission + + @required_permission.setter + def required_permission(self, required_permission): + """ + Sets the required_permission of this Restriction. + The permission required for this restriction + + :param required_permission: The required_permission of this Restriction. + :type: str + """ + + self._required_permission = required_permission + + @property + def explanation(self): + """ + Gets the explanation of this Restriction. + The explanation of this restriction + + :return: The explanation of this Restriction. + :rtype: str + """ + return self._explanation + + @explanation.setter + def explanation(self, explanation): + """ + Sets the explanation of this Restriction. + The explanation of this restriction + + :param explanation: The explanation of this Restriction. + :type: str + """ + + self._explanation = explanation + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Restriction): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/stateful.py b/nipyapi/registry/models/stateful.py new file mode 100644 index 00000000..bd0fa557 --- /dev/null +++ b/nipyapi/registry/models/stateful.py @@ -0,0 +1,160 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class Stateful(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', + 'scopes': 'list[str]' + } + + attribute_map = { + 'description': 'description', + 'scopes': 'scopes' + } + + def __init__(self, description=None, scopes=None): + """ + Stateful - a model defined in Swagger + """ + + self._description = None + self._scopes = None + + if description is not None: + self.description = description + if scopes is not None: + self.scopes = scopes + + @property + def description(self): + """ + Gets the description of this Stateful. + The description for how the extension stores state + + :return: The description of this Stateful. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this Stateful. + The description for how the extension stores state + + :param description: The description of this Stateful. + :type: str + """ + + self._description = description + + @property + def scopes(self): + """ + Gets the scopes of this Stateful. + The scopes used to store state + + :return: The scopes of this Stateful. + :rtype: list[str] + """ + return self._scopes + + @scopes.setter + def scopes(self, scopes): + """ + Sets the scopes of this Stateful. + The scopes used to store state + + :param scopes: The scopes of this Stateful. + :type: list[str] + """ + allowed_values = ["CLUSTER", "LOCAL"] + if not set(scopes).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `scopes` [{0}], must be a subset of [{1}]" + .format(", ".join(map(str, set(scopes)-set(allowed_values))), + ", ".join(map(str, allowed_values))) + ) + + self._scopes = scopes + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Stateful): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/system_resource_consideration.py b/nipyapi/registry/models/system_resource_consideration.py new file mode 100644 index 00000000..84acb247 --- /dev/null +++ b/nipyapi/registry/models/system_resource_consideration.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class SystemResourceConsideration(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'resource': 'str', + 'description': 'str' + } + + attribute_map = { + 'resource': 'resource', + 'description': 'description' + } + + def __init__(self, resource=None, description=None): + """ + SystemResourceConsideration - a model defined in Swagger + """ + + self._resource = None + self._description = None + + if resource is not None: + self.resource = resource + if description is not None: + self.description = description + + @property + def resource(self): + """ + Gets the resource of this SystemResourceConsideration. + The resource to consider + + :return: The resource of this SystemResourceConsideration. + :rtype: str + """ + return self._resource + + @resource.setter + def resource(self, resource): + """ + Sets the resource of this SystemResourceConsideration. + The resource to consider + + :param resource: The resource of this SystemResourceConsideration. + :type: str + """ + + self._resource = resource + + @property + def description(self): + """ + Gets the description of this SystemResourceConsideration. + The description of how the resource is affected + + :return: The description of this SystemResourceConsideration. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this SystemResourceConsideration. + The description of how the resource is affected + + :param description: The description of this SystemResourceConsideration. + :type: str + """ + + self._description = description + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, SystemResourceConsideration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/uri_builder.py b/nipyapi/registry/models/tag_count.py similarity index 61% rename from nipyapi/registry/models/uri_builder.py rename to nipyapi/registry/models/tag_count.py index 86600794..cf34e0ee 100644 --- a/nipyapi/registry/models/uri_builder.py +++ b/nipyapi/registry/models/tag_count.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -16,7 +16,7 @@ import re -class UriBuilder(object): +class TagCount(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -31,19 +31,73 @@ class UriBuilder(object): and the value is json key in definition. """ swagger_types = { - + 'tag': 'str', + 'count': 'int' } attribute_map = { - + 'tag': 'tag', + 'count': 'count' } - def __init__(self): + def __init__(self, tag=None, count=None): + """ + TagCount - a model defined in Swagger + """ + + self._tag = None + self._count = None + + if tag is not None: + self.tag = tag + if count is not None: + self.count = count + + @property + def tag(self): + """ + Gets the tag of this TagCount. + The tag label + + :return: The tag of this TagCount. + :rtype: str + """ + return self._tag + + @tag.setter + def tag(self, tag): + """ + Sets the tag of this TagCount. + The tag label + + :param tag: The tag of this TagCount. + :type: str + """ + + self._tag = tag + + @property + def count(self): """ - UriBuilder - a model defined in Swagger + Gets the count of this TagCount. + The number of occurrences of the given tag + + :return: The count of this TagCount. + :rtype: int """ + return self._count + @count.setter + def count(self, count): + """ + Sets the count of this TagCount. + The number of occurrences of the given tag + + :param count: The count of this TagCount. + :type: int + """ + self._count = count def to_dict(self): """ @@ -87,7 +141,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, UriBuilder): + if not isinstance(other, TagCount): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/registry/models/tenant.py b/nipyapi/registry/models/tenant.py index dd7d892d..b087e523 100644 --- a/nipyapi/registry/models/tenant.py +++ b/nipyapi/registry/models/tenant.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/user.py b/nipyapi/registry/models/user.py index 5bd6d3d6..06b3f2f3 100644 --- a/nipyapi/registry/models/user.py +++ b/nipyapi/registry/models/user.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/user_group.py b/nipyapi/registry/models/user_group.py index b5b61f47..0819dc6d 100644 --- a/nipyapi/registry/models/user_group.py +++ b/nipyapi/registry/models/user_group.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_connection.py b/nipyapi/registry/models/versioned_connection.py index 9ca48fa8..25bccaa1 100644 --- a/nipyapi/registry/models/versioned_connection.py +++ b/nipyapi/registry/models/versioned_connection.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -45,6 +45,9 @@ class VersionedConnection(object): 'flow_file_expiration': 'str', 'prioritizers': 'list[str]', 'bends': 'list[Position]', + 'load_balance_strategy': 'str', + 'partitioning_attribute': 'str', + 'load_balance_compression': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -64,11 +67,14 @@ class VersionedConnection(object): 'flow_file_expiration': 'flowFileExpiration', 'prioritizers': 'prioritizers', 'bends': 'bends', + 'load_balance_strategy': 'loadBalanceStrategy', + 'partitioning_attribute': 'partitioningAttribute', + 'load_balance_compression': 'loadBalanceCompression', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, component_type=None, group_identifier=None): + def __init__(self, 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): """ VersionedConnection - a model defined in Swagger """ @@ -87,6 +93,9 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, sou self._flow_file_expiration = None self._prioritizers = None self._bends = None + self._load_balance_strategy = None + self._partitioning_attribute = None + self._load_balance_compression = None self._component_type = None self._group_identifier = None @@ -118,6 +127,12 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, sou self.prioritizers = prioritizers if bends is not None: self.bends = bends + if load_balance_strategy is not None: + self.load_balance_strategy = load_balance_strategy + if partitioning_attribute is not None: + self.partitioning_attribute = partitioning_attribute + if load_balance_compression is not None: + self.load_balance_compression = load_balance_compression if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -445,6 +460,87 @@ def bends(self, bends): self._bends = bends + @property + def load_balance_strategy(self): + """ + 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. + + :return: The load_balance_strategy of this VersionedConnection. + :rtype: str + """ + return self._load_balance_strategy + + @load_balance_strategy.setter + def load_balance_strategy(self, load_balance_strategy): + """ + Sets 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. + + :param load_balance_strategy: The load_balance_strategy of this VersionedConnection. + :type: str + """ + allowed_values = ["DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE"] + if load_balance_strategy not in allowed_values: + raise ValueError( + "Invalid value for `load_balance_strategy` ({0}), must be one of {1}" + .format(load_balance_strategy, allowed_values) + ) + + self._load_balance_strategy = load_balance_strategy + + @property + def partitioning_attribute(self): + """ + 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. + + :return: The partitioning_attribute of this VersionedConnection. + :rtype: str + """ + return self._partitioning_attribute + + @partitioning_attribute.setter + def partitioning_attribute(self, partitioning_attribute): + """ + Sets 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. + + :param partitioning_attribute: The partitioning_attribute of this VersionedConnection. + :type: str + """ + + self._partitioning_attribute = partitioning_attribute + + @property + def load_balance_compression(self): + """ + Gets the load_balance_compression of this VersionedConnection. + Whether or not compression should be used when transferring FlowFiles between nodes + + :return: The load_balance_compression of this VersionedConnection. + :rtype: str + """ + return self._load_balance_compression + + @load_balance_compression.setter + def load_balance_compression(self, load_balance_compression): + """ + Sets the load_balance_compression of this VersionedConnection. + Whether or not compression should be used when transferring FlowFiles between nodes + + :param load_balance_compression: The load_balance_compression of this VersionedConnection. + :type: str + """ + allowed_values = ["DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT"] + if load_balance_compression not in allowed_values: + raise ValueError( + "Invalid value for `load_balance_compression` ({0}), must be one of {1}" + .format(load_balance_compression, allowed_values) + ) + + self._load_balance_compression = load_balance_compression + @property def component_type(self): """ diff --git a/nipyapi/registry/models/versioned_controller_service.py b/nipyapi/registry/models/versioned_controller_service.py index ce65233f..0bd67613 100644 --- a/nipyapi/registry/models/versioned_controller_service.py +++ b/nipyapi/registry/models/versioned_controller_service.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow.py b/nipyapi/registry/models/versioned_flow.py index 54dc714a..6ba36e31 100644 --- a/nipyapi/registry/models/versioned_flow.py +++ b/nipyapi/registry/models/versioned_flow.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,7 +31,7 @@ class VersionedFlow(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'identifier': 'str', 'name': 'str', 'description': 'str', @@ -102,7 +102,7 @@ def link(self): An WebLink to this entity. :return: The link of this VersionedFlow. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -113,7 +113,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this VersionedFlow. - :type: Link + :type: JaxbLink """ self._link = link @@ -309,7 +309,7 @@ def type(self, type): """ if type is None: raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["Flow"] + allowed_values = ["Flow", "Bundle"] if type not in allowed_values: raise ValueError( "Invalid value for `type` ({0}), must be one of {1}" diff --git a/nipyapi/registry/models/versioned_flow_coordinates.py b/nipyapi/registry/models/versioned_flow_coordinates.py index a2c611e3..5d3ffd05 100644 --- a/nipyapi/registry/models/versioned_flow_coordinates.py +++ b/nipyapi/registry/models/versioned_flow_coordinates.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_difference.py b/nipyapi/registry/models/versioned_flow_difference.py index d68f203f..5fdf9f76 100644 --- a/nipyapi/registry/models/versioned_flow_difference.py +++ b/nipyapi/registry/models/versioned_flow_difference.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot.py b/nipyapi/registry/models/versioned_flow_snapshot.py index 8f526fe5..384eb081 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot.py +++ b/nipyapi/registry/models/versioned_flow_snapshot.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,6 +33,9 @@ class VersionedFlowSnapshot(object): swagger_types = { 'snapshot_metadata': 'VersionedFlowSnapshotMetadata', 'flow_contents': 'VersionedProcessGroup', + 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', + 'parameter_contexts': 'dict(str, VersionedParameterContext)', + 'flow_encoding_version': 'str', 'flow': 'VersionedFlow', 'bucket': 'Bucket', 'latest': 'bool' @@ -41,24 +44,36 @@ class VersionedFlowSnapshot(object): attribute_map = { 'snapshot_metadata': 'snapshotMetadata', 'flow_contents': 'flowContents', + 'external_controller_services': 'externalControllerServices', + 'parameter_contexts': 'parameterContexts', + 'flow_encoding_version': 'flowEncodingVersion', 'flow': 'flow', 'bucket': 'bucket', 'latest': 'latest' } - def __init__(self, snapshot_metadata=None, flow_contents=None, flow=None, bucket=None, latest=None): + def __init__(self, snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None): """ VersionedFlowSnapshot - a model defined in Swagger """ self._snapshot_metadata = None self._flow_contents = None + self._external_controller_services = None + self._parameter_contexts = None + self._flow_encoding_version = None self._flow = None self._bucket = None self._latest = None self.snapshot_metadata = snapshot_metadata self.flow_contents = flow_contents + if external_controller_services is not None: + self.external_controller_services = external_controller_services + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if flow_encoding_version is not None: + self.flow_encoding_version = flow_encoding_version if flow is not None: self.flow = flow if bucket is not None: @@ -116,6 +131,75 @@ def flow_contents(self, flow_contents): self._flow_contents = flow_contents + @property + def external_controller_services(self): + """ + 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. + + :return: The external_controller_services of this VersionedFlowSnapshot. + :rtype: dict(str, ExternalControllerServiceReference) + """ + return self._external_controller_services + + @external_controller_services.setter + def external_controller_services(self, external_controller_services): + """ + Sets 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. + + :param external_controller_services: The external_controller_services of this VersionedFlowSnapshot. + :type: dict(str, ExternalControllerServiceReference) + """ + + self._external_controller_services = external_controller_services + + @property + def parameter_contexts(self): + """ + 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. + + :return: The parameter_contexts of this VersionedFlowSnapshot. + :rtype: dict(str, VersionedParameterContext) + """ + return self._parameter_contexts + + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): + """ + Sets 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. + + :param parameter_contexts: The parameter_contexts of this VersionedFlowSnapshot. + :type: dict(str, VersionedParameterContext) + """ + + self._parameter_contexts = parameter_contexts + + @property + def flow_encoding_version(self): + """ + Gets the flow_encoding_version of this VersionedFlowSnapshot. + The optional encoding version of the flow contents. + + :return: The flow_encoding_version of this VersionedFlowSnapshot. + :rtype: str + """ + return self._flow_encoding_version + + @flow_encoding_version.setter + def flow_encoding_version(self, flow_encoding_version): + """ + Sets the flow_encoding_version of this VersionedFlowSnapshot. + The optional encoding version of the flow contents. + + :param flow_encoding_version: The flow_encoding_version of this VersionedFlowSnapshot. + :type: str + """ + + self._flow_encoding_version = flow_encoding_version + @property def flow(self): """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py index a8924fd5..6ef9847c 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,7 +31,7 @@ class VersionedFlowSnapshotMetadata(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'bucket_identifier': 'str', 'flow_identifier': 'str', 'version': 'int', @@ -82,7 +82,7 @@ def link(self): An WebLink to this entity. :return: The link of this VersionedFlowSnapshotMetadata. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -93,7 +93,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this VersionedFlowSnapshotMetadata. - :type: Link + :type: JaxbLink """ self._link = link @@ -170,8 +170,8 @@ def version(self, version): """ if version is None: raise ValueError("Invalid value for `version`, must not be `None`") - if version is not None and version < 1: - raise ValueError("Invalid value for `version`, must be a value greater than or equal to `1`") + if version is not None and version < -1: + raise ValueError("Invalid value for `version`, must be a value greater than or equal to `-1`") self._version = version diff --git a/nipyapi/registry/models/versioned_funnel.py b/nipyapi/registry/models/versioned_funnel.py index 289002c6..a12b61a7 100644 --- a/nipyapi/registry/models/versioned_funnel.py +++ b/nipyapi/registry/models/versioned_funnel.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_label.py b/nipyapi/registry/models/versioned_label.py index 4e2ef17f..0a341dd8 100644 --- a/nipyapi/registry/models/versioned_label.py +++ b/nipyapi/registry/models/versioned_label.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_parameter.py b/nipyapi/registry/models/versioned_parameter.py new file mode 100644 index 00000000..0efa6516 --- /dev/null +++ b/nipyapi/registry/models/versioned_parameter.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedParameter(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'sensitive': 'bool', + 'value': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'sensitive': 'sensitive', + 'value': 'value' + } + + def __init__(self, name=None, description=None, sensitive=None, value=None): + """ + VersionedParameter - a model defined in Swagger + """ + + self._name = None + self._description = None + self._sensitive = None + self._value = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if sensitive is not None: + self.sensitive = sensitive + if value is not None: + self.value = value + + @property + def name(self): + """ + Gets the name of this VersionedParameter. + The name of the parameter + + :return: The name of this VersionedParameter. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedParameter. + The name of the parameter + + :param name: The name of this VersionedParameter. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this VersionedParameter. + The description of the param + + :return: The description of this VersionedParameter. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VersionedParameter. + The description of the param + + :param description: The description of this VersionedParameter. + :type: str + """ + + self._description = description + + @property + def sensitive(self): + """ + Gets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :return: The sensitive of this VersionedParameter. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :param sensitive: The sensitive of this VersionedParameter. + :type: bool + """ + + self._sensitive = sensitive + + @property + def value(self): + """ + Gets the value of this VersionedParameter. + The value of the parameter + + :return: The value of this VersionedParameter. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this VersionedParameter. + The value of the parameter + + :param value: The value of this VersionedParameter. + :type: str + """ + + self._value = value + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedParameter): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/versioned_parameter_context.py b/nipyapi/registry/models/versioned_parameter_context.py new file mode 100644 index 00000000..4ae3dbd8 --- /dev/null +++ b/nipyapi/registry/models/versioned_parameter_context.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.5.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedParameterContext(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'parameters': 'list[VersionedParameter]' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'parameters': 'parameters' + } + + def __init__(self, name=None, description=None, parameters=None): + """ + VersionedParameterContext - a model defined in Swagger + """ + + self._name = None + self._description = None + self._parameters = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if parameters is not None: + self.parameters = parameters + + @property + def name(self): + """ + Gets the name of this VersionedParameterContext. + The name of the context + + :return: The name of this VersionedParameterContext. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedParameterContext. + The name of the context + + :param name: The name of this VersionedParameterContext. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this VersionedParameterContext. + The description of the parameter context + + :return: The description of this VersionedParameterContext. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VersionedParameterContext. + The description of the parameter context + + :param description: The description of this VersionedParameterContext. + :type: str + """ + + self._description = description + + @property + def parameters(self): + """ + Gets the parameters of this VersionedParameterContext. + The parameters in the context + + :return: The parameters of this VersionedParameterContext. + :rtype: list[VersionedParameter] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this VersionedParameterContext. + The parameters in the context + + :param parameters: The parameters of this VersionedParameterContext. + :type: list[VersionedParameter] + """ + + self._parameters = parameters + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedParameterContext): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/versioned_port.py b/nipyapi/registry/models/versioned_port.py index 7be03430..90f1465c 100644 --- a/nipyapi/registry/models/versioned_port.py +++ b/nipyapi/registry/models/versioned_port.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -37,6 +37,8 @@ class VersionedPort(object): 'position': 'Position', 'type': 'str', 'concurrently_schedulable_task_count': 'int', + 'scheduled_state': 'str', + 'allow_remote_access': 'bool', 'component_type': 'str', 'group_identifier': 'str' } @@ -48,11 +50,13 @@ class VersionedPort(object): 'position': 'position', 'type': 'type', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', + 'scheduled_state': 'scheduledState', + 'allow_remote_access': 'allowRemoteAccess', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, component_type=None, group_identifier=None): + def __init__(self, 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): """ VersionedPort - a model defined in Swagger """ @@ -63,6 +67,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, typ self._position = None self._type = None self._concurrently_schedulable_task_count = None + self._scheduled_state = None + self._allow_remote_access = None self._component_type = None self._group_identifier = None @@ -78,6 +84,10 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, typ self.type = type if concurrently_schedulable_task_count is not None: self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if scheduled_state is not None: + self.scheduled_state = scheduled_state + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -227,6 +237,58 @@ def concurrently_schedulable_task_count(self, concurrently_schedulable_task_coun self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedPort. + The scheduled state of the component + + :return: The scheduled_state of this VersionedPort. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedPort. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedPort. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :return: The allow_remote_access of this VersionedPort. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :param allow_remote_access: The allow_remote_access of this VersionedPort. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + @property def component_type(self): """ diff --git a/nipyapi/registry/models/versioned_process_group.py b/nipyapi/registry/models/versioned_process_group.py index af25bffc..9ee76f41 100644 --- a/nipyapi/registry/models/versioned_process_group.py +++ b/nipyapi/registry/models/versioned_process_group.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -46,6 +46,7 @@ class VersionedProcessGroup(object): 'controller_services': 'list[VersionedControllerService]', 'versioned_flow_coordinates': 'VersionedFlowCoordinates', 'variables': 'dict(str, str)', + 'parameter_context_name': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -66,11 +67,12 @@ class VersionedProcessGroup(object): 'controller_services': 'controllerServices', 'versioned_flow_coordinates': 'versionedFlowCoordinates', 'variables': 'variables', + 'parameter_context_name': 'parameterContextName', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, component_type=None, group_identifier=None): + def __init__(self, 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, component_type=None, group_identifier=None): """ VersionedProcessGroup - a model defined in Swagger """ @@ -90,6 +92,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self._controller_services = None self._versioned_flow_coordinates = None self._variables = None + self._parameter_context_name = None self._component_type = None self._group_identifier = None @@ -123,6 +126,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self.versioned_flow_coordinates = versioned_flow_coordinates if variables is not None: self.variables = variables + if parameter_context_name is not None: + self.parameter_context_name = parameter_context_name if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -473,6 +478,29 @@ def variables(self, variables): self._variables = variables + @property + def parameter_context_name(self): + """ + Gets the parameter_context_name of this VersionedProcessGroup. + The name of the parameter context used by this process group + + :return: The parameter_context_name of this VersionedProcessGroup. + :rtype: str + """ + return self._parameter_context_name + + @parameter_context_name.setter + def parameter_context_name(self, parameter_context_name): + """ + Sets the parameter_context_name of this VersionedProcessGroup. + The name of the parameter context used by this process group + + :param parameter_context_name: The parameter_context_name of this VersionedProcessGroup. + :type: str + """ + + self._parameter_context_name = parameter_context_name + @property def component_type(self): """ diff --git a/nipyapi/registry/models/versioned_processor.py b/nipyapi/registry/models/versioned_processor.py index dd236071..0346939d 100644 --- a/nipyapi/registry/models/versioned_processor.py +++ b/nipyapi/registry/models/versioned_processor.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -50,6 +50,7 @@ class VersionedProcessor(object): 'run_duration_millis': 'int', 'concurrently_schedulable_task_count': 'int', 'auto_terminated_relationships': 'list[str]', + 'scheduled_state': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -74,11 +75,12 @@ class VersionedProcessor(object): 'run_duration_millis': 'runDurationMillis', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'auto_terminated_relationships': 'autoTerminatedRelationships', + 'scheduled_state': 'scheduledState', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, name=None, comments=None, position=None, bundle=None, style=None, type=None, properties=None, property_descriptors=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, component_type=None, group_identifier=None): + def __init__(self, identifier=None, name=None, comments=None, position=None, bundle=None, style=None, type=None, properties=None, property_descriptors=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, component_type=None, group_identifier=None): """ VersionedProcessor - a model defined in Swagger """ @@ -102,6 +104,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, bun self._run_duration_millis = None self._concurrently_schedulable_task_count = None self._auto_terminated_relationships = None + self._scheduled_state = None self._component_type = None self._group_identifier = None @@ -143,6 +146,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, bun self.concurrently_schedulable_task_count = concurrently_schedulable_task_count if auto_terminated_relationships is not None: self.auto_terminated_relationships = auto_terminated_relationships + if scheduled_state is not None: + self.scheduled_state = scheduled_state if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -585,6 +590,35 @@ def auto_terminated_relationships(self, auto_terminated_relationships): self._auto_terminated_relationships = auto_terminated_relationships + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedProcessor. + The scheduled state of the component + + :return: The scheduled_state of this VersionedProcessor. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedProcessor. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedProcessor. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + @property def component_type(self): """ diff --git a/nipyapi/registry/models/versioned_property_descriptor.py b/nipyapi/registry/models/versioned_property_descriptor.py index 2148695c..90f9c72f 100644 --- a/nipyapi/registry/models/versioned_property_descriptor.py +++ b/nipyapi/registry/models/versioned_property_descriptor.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_remote_group_port.py b/nipyapi/registry/models/versioned_remote_group_port.py index 0a4fac5e..0eff66b6 100644 --- a/nipyapi/registry/models/versioned_remote_group_port.py +++ b/nipyapi/registry/models/versioned_remote_group_port.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,6 +41,7 @@ class VersionedRemoteGroupPort(object): 'batch_size': 'BatchSize', 'component_type': 'str', 'target_id': 'str', + 'scheduled_state': 'str', 'group_identifier': 'str' } @@ -55,10 +56,11 @@ class VersionedRemoteGroupPort(object): 'batch_size': 'batchSize', 'component_type': 'componentType', 'target_id': 'targetId', + 'scheduled_state': 'scheduledState', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, group_identifier=None): + def __init__(self, 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): """ VersionedRemoteGroupPort - a model defined in Swagger """ @@ -73,6 +75,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, rem self._batch_size = None self._component_type = None self._target_id = None + self._scheduled_state = None self._group_identifier = None if identifier is not None: @@ -95,6 +98,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, rem self.component_type = component_type if target_id is not None: self.target_id = target_id + if scheduled_state is not None: + self.scheduled_state = scheduled_state if group_identifier is not None: self.group_identifier = group_identifier @@ -332,6 +337,35 @@ def target_id(self, target_id): self._target_id = target_id + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component + + :return: The scheduled_state of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedRemoteGroupPort. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + @property def group_identifier(self): """ diff --git a/nipyapi/registry/models/versioned_remote_process_group.py b/nipyapi/registry/models/versioned_remote_process_group.py index 75feda22..acbdba3d 100644 --- a/nipyapi/registry/models/versioned_remote_process_group.py +++ b/nipyapi/registry/models/versioned_remote_process_group.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -224,7 +224,7 @@ def position(self, position): def target_uri(self): """ Gets the target_uri of this VersionedRemoteProcessGroup. - 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. + [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. :return: The target_uri of this VersionedRemoteProcessGroup. :rtype: str @@ -235,7 +235,7 @@ def target_uri(self): def target_uri(self, target_uri): """ Sets the target_uri of this VersionedRemoteProcessGroup. - 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. + [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. :param target_uri: The target_uri of this VersionedRemoteProcessGroup. :type: str @@ -247,7 +247,7 @@ def target_uri(self, target_uri): def target_uris(self): """ Gets the target_uris of this VersionedRemoteProcessGroup. - The target URI 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. + 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. :return: The target_uris of this VersionedRemoteProcessGroup. :rtype: str @@ -258,7 +258,7 @@ def target_uris(self): def target_uris(self, target_uris): """ Sets the target_uris of this VersionedRemoteProcessGroup. - The target URI 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. + 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. :param target_uris: The target_uris of this VersionedRemoteProcessGroup. :type: str diff --git a/nipyapi/registry/rest.py b/nipyapi/registry/rest.py index 2574459e..05edc1ac 100644 --- a/nipyapi/registry/rest.py +++ b/nipyapi/registry/rest.py @@ -1,11 +1,11 @@ # coding: utf-8 """ - NiFi Registry REST API + Apache NiFi Registry REST API The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OUTPUTOpenAPI spec version: 0.3.0 + OpenAPI spec version: 0.5.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/security.py b/nipyapi/security.py index 2da6a49e..e3ac8615 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -835,8 +835,9 @@ def bootstrap_security_policies(service, user_identity=None, strict=False ) proxy_access_policies = [ + ("read", "/proxy"), ("write", "/proxy"), - ("read", "/buckets") + ("delete", "/proxy"), ] for action, resource in proxy_access_policies: pol = nipyapi.security.get_access_policy_for_resource( diff --git a/resources/client_gen/api_defs/registry-0.5.0.json b/resources/client_gen/api_defs/registry-0.5.0.json new file mode 100644 index 00000000..0b5ea737 --- /dev/null +++ b/resources/client_gen/api_defs/registry-0.5.0.json @@ -0,0 +1,6341 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", + "version" : "0.5.0", + "title" : "Apache NiFi Registry REST API", + "termsOfService" : "As described in the license", + "contact" : { + "name" : "Apache NiFi Registry", + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0 License", + "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-registry-api", + "tags" : [ { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "bucket bundles", + "description" : "Create extension bundles scoped to an existing bucket in the registry. " + }, { + "name" : "bucket flows", + "description" : "Create flows scoped to an existing bucket in the registry." + }, { + "name" : "buckets", + "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." + }, { + "name" : "bundles", + "description" : "Gets metadata about extension bundles and their versions. " + }, { + "name" : "config", + "description" : "Retrieves the configuration for this NiFi Registry." + }, { + "name" : "extension repository", + "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " + }, { + "name" : "extensions", + "description" : "Find and retrieve extensions. " + }, { + "name" : "flows", + "description" : "Gets metadata about flows." + }, { + "name" : "items", + "description" : "Retrieve items across all buckets for which the user is authorized." + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Get access status", + "description" : "Returns the current client's authenticated identity and permissions to top-level resources", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUser" + } + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token trying all providers", + "description" : "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 '.", + "operationId" : "createAccessTokenByTryingAllProviders", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using identity provider", + "description" : "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 '.", + "operationId" : "createAccessTokenUsingIdentityProviderCredentials", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider/test" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Test identity provider", + "description" : "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'.", + "operationId" : "testIdentityProviderRecognizesCredentialsFormat", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "The format of the credentials were not recognized by the currently configured identity provider." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider/usage" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Get identity provider usage", + "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", + "operationId" : "getIdentityProviderUsageInstructions", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using kerberos", + "description" : "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 '.", + "operationId" : "createAccessTokenUsingKerberosTicket", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/login" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using basic auth", + "description" : "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 ', where is the base64 encoded value of ':'. 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 '.", + "operationId" : "createAccessTokenUsingBasicAuthCredentials", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + }, + "security" : [ { + "BasicAuth" : [ ] + } ] + } + }, + "/buckets" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get all buckets", + "description" : "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.", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Bucket" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + }, + "post" : { + "tags" : [ "buckets" ], + "summary" : "Create bucket", + "description" : "", + "operationId" : "createBucket", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The bucket to create", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Bucket" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets", + "action" : "write" + } + } + }, + "/buckets/fields" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get bucket fields", + "description" : "Retrieves bucket field names for searching or sorting on buckets.", + "operationId" : "getAvailableBucketFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/buckets/{bucketId}" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get bucket", + "description" : "Gets the bucket with the given id.", + "operationId" : "getBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "put" : { + "tags" : [ "buckets" ], + "summary" : "Update bucket", + "description" : "Updates the bucket with the given id.", + "operationId" : "updateBucket", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated bucket", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Bucket" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "buckets" ], + "summary" : "Delete bucket", + "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", + "operationId" : "deleteBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "delete" + } + } + }, + "/buckets/{bucketId}/bundles" : { + "get" : { + "tags" : [ "bucket bundles" ], + "summary" : "Get extension bundles by bucket", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionBundles", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionBundle" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/bundles/{bundleType}" : { + "post" : { + "tags" : [ "bucket bundles" ], + "summary" : "Create extension bundle version", + "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createExtensionBundleVersion", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "bundleType", + "in" : "path", + "description" : "The type of the bundle", + "required" : true, + "type" : "string", + "enum" : [ "nifi-nar", "minifi-cpp" ] + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flows", + "description" : "Retrieves all flows in the given bucket.", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlow" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "post" : { + "tags" : [ "bucket flows" ], + "summary" : "Create flow", + "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", + "operationId" : "createFlow", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The details of the flow to create.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow", + "description" : "Retrieves the flow with the given id in the given bucket.", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "put" : { + "tags" : [ "bucket flows" ], + "summary" : "Update bucket flow", + "description" : "Updates the flow with the given id in the given bucket.", + "operationId" : "updateFlow", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated flow", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "bucket flows" ], + "summary" : "Delete bucket flow", + "description" : "Deletes a flow, including all saved versions of that flow.", + "operationId" : "deleteFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "delete" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow diff", + "description" : "Computes the differences between two given versions of a flow.", + "operationId" : "getFlowDiff", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionA", + "in" : "path", + "description" : "The first version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + }, { + "name" : "versionB", + "in" : "path", + "description" : "The second version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowDifference" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow versions", + "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", + "operationId" : "getFlowVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "post" : { + "tags" : [ "bucket flows" ], + "summary" : "Create flow version", + "description" : "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.", + "operationId" : "createFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The new versioned flow snapshot.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get latest bucket flow version content", + "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", + "operationId" : "getLatestFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get latest bucket flow version metadata", + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "getLatestFlowVersionMetadata", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow version", + "description" : "Gets the given version of a flow, including the metadata and content for the version.", + "operationId" : "getFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionNumber", + "in" : "path", + "description" : "The version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get all bundles", + "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results 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. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundles", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "query", + "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", + "required" : false, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionBundle" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/bundles/versions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get all bundle versions", + "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "query", + "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", + "required" : false, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", + "required" : false, + "type" : "string" + }, { + "name" : "version", + "in" : "query", + "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BundleVersionMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/bundles/{bundleId}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle", + "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetExtensionBundle", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionBundle" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "delete" : { + "tags" : [ "bundles" ], + "summary" : "Delete bundle", + "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalDeleteExtensionBundle", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionBundle" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/bundles/{bundleId}/versions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle versions", + "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BundleVersionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version", + "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "delete" : { + "tags" : [ "bundles" ], + "summary" : "Delete bundle version", + "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalDeleteBundleVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/bundles/{bundleId}/versions/{version}/content" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version content", + "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionContent", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extensions", + "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension", + "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionExtension", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Extension" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension docs", + "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersionExtensionDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension docs details", + "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/config" : { + "get" : { + "tags" : [ "config" ], + "summary" : "Get configration", + "description" : "Gets the NiFi Registry configurations.", + "operationId" : "getConfiguration", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryConfiguration" + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies,/tenants", + "action" : "read" + } + } + }, + "/extension-repository" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo buckets", + "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoBucket" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extension-repository/{bucketName}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo groups", + "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoGroup" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo artifacts", + "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoArtifacts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group id", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoArtifact" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo versions", + "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoVersionSummary" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version", + "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionRepoVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version content", + "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionContent", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extensions", + "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension", + "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtension", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Extension" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension docs", + "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensionDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension details", + "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version checksum", + "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionSha256", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get global extension repo version checksum", + "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getGlobalExtensionRepoVersionSha256", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get all extensions", + "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleType", + "in" : "query", + "description" : "The type of bundles to return", + "required" : false, + "type" : "string", + "enum" : [ "nifi-nar", "minifi-cpp" ] + }, { + "name" : "extensionType", + "in" : "query", + "description" : "The type of extensions to return", + "required" : false, + "type" : "string", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, { + "name" : "tag", + "in" : "query", + "description" : "The tags to filter on, will be used in an OR statement", + "required" : false, + "type" : "array", + "items" : { + "type" : "string" + }, + "collectionFormat" : "multi" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionMetadataContainer" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions/provided-service-api" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get extensions providing service API", + "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionsProvidingServiceAPI", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "className", + "in" : "query", + "description" : "The name of the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "The groupId of the bundle containing the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "The artifactId of the bundle containing the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "query", + "description" : "The version of the bundle containing the service API class", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionMetadataContainer" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions/tags" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get extension tags", + "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getTags", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TagCount" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/flows/fields" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow fields", + "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", + "operationId" : "getAvailableFlowFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/flows/{flowId}" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow", + "description" : "Gets a flow by id.", + "operationId" : "globalGetFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow versions", + "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", + "operationId" : "globalGetFlowVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/latest" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get latest flow version", + "description" : "Gets the latest version of a flow, including metadata and flow content.", + "operationId" : "globalGetLatestFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get latest flow version metadata", + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "globalGetLatestFlowVersionMetadata", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow version", + "description" : "Gets the given version of a flow, including metadata and flow content.", + "operationId" : "globalGetFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionNumber", + "in" : "path", + "description" : "The version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/items" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get all items", + "description" : "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.", + "operationId" : "getItems", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BucketItem" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/items/fields" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get item fields", + "description" : "Retrieves the item field names for searching or sorting on bucket items.", + "operationId" : "getAvailableBucketItemFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/items/{bucketId}" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get bucket items", + "description" : "Gets the items located in the given bucket.", + "operationId" : "getItemsInBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BucketItem" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/policies" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get all access policies", + "description" : "", + "operationId" : "getAccessPolicies", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/AccessPolicy" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + }, + "post" : { + "tags" : [ "policies" ], + "summary" : "Create access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "write" + } + } + }, + "/policies/resources" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get available resources", + "description" : "Gets the available resources that support access/authorization policies", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Resource" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get access policy for resource", + "description" : "Gets an access policy for the specified action and resource", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write", "delete" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Update access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Delete access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "delete" + } + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user groups", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroup" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Create user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Update user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Delete user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "delete" + } + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get all users", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/User" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Create user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/User" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Update user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/User" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Delete user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "delete" + } + } + } + }, + "securityDefinitions" : { + "Authorization" : { + "description" : "NiFi Registry Auth Token (JWT)", + "type" : "apiKey", + "name" : "Authorization", + "in" : "header" + }, + "BasicAuth" : { + "description" : "HTTP Basic Auth", + "type" : "basic" + } + }, + "definitions" : { + "AccessPolicy" : { + "type" : "object", + "required" : [ "action", "resource" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The id of the policy. Set by server at creation time.", + "readOnly" : true + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write", "delete" ] + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", + "readOnly" : true + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "AccessPolicySummary" : { + "type" : "object", + "required" : [ "action", "resource" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The id of the policy. Set by server at creation time.", + "readOnly" : true + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write", "delete" ] + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", + "readOnly" : true + } + } + }, + "AllowableValue" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string", + "description" : "The value of the allowable value" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the allowable value" + }, + "description" : { + "type" : "string", + "description" : "The description of the allowable value" + } + } + }, + "Attribute" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the attribute" + }, + "description" : { + "type" : "string", + "description" : "The description of the attribute" + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "Bucket" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket." + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "readOnly" : true, + "minimum" : 1 + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "allowBundleRedeploy" : { + "type" : "boolean", + "description" : "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." + }, + "allowPublicRead" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" + }, + "permissions" : { + "description" : "The access that the current user has to this bucket.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "BucketItem" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "BuildInfo" : { + "type" : "object", + "properties" : { + "buildTool" : { + "type" : "string", + "description" : "The tool used to build the version of the bundle" + }, + "buildFlags" : { + "type" : "string", + "description" : "The flags used to build the version of the bundle" + }, + "buildBranch" : { + "type" : "string", + "description" : "The branch used to build the version of the bundle" + }, + "buildTag" : { + "type" : "string", + "description" : "The tag used to build the version of the bundle" + }, + "buildRevision" : { + "type" : "string", + "description" : "The revision used to build the version of the bundle" + }, + "built" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp the version of the bundle was built" + }, + "builtBy" : { + "type" : "string", + "description" : "The identity of the user that performed the build" + } + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleInfo" : { + "type" : "object", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket where the bundle is located" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket where the bundle is located" + }, + "bundleId" : { + "type" : "string", + "description" : "The id of the bundle" + }, + "bundleType" : { + "type" : "string", + "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the bundle" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API the bundle was built against" + } + } + }, + "BundleVersion" : { + "type" : "object", + "required" : [ "versionMetadata" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "versionMetadata" : { + "description" : "The metadata about this version of the extension bundle", + "$ref" : "#/definitions/BundleVersionMetadata" + }, + "dependencies" : { + "type" : "array", + "description" : "The set of other bundle versions that this version is dependent on", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BundleVersionDependency" + } + }, + "bundle" : { + "description" : "The bundle this version is for", + "readOnly" : true, + "$ref" : "#/definitions/ExtensionBundle" + }, + "bucket" : { + "description" : "The bucket that the extension bundle belongs to", + "$ref" : "#/definitions/Bucket" + }, + "filename" : { + "type" : "string" + } + } + }, + "BundleVersionDependency" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The group id of the bundle dependency" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle dependency" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle dependency" + } + } + }, + "BundleVersionMetadata" : { + "type" : "object", + "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "id" : { + "type" : "string", + "description" : "The id of this version of the extension bundle" + }, + "bundleId" : { + "type" : "string", + "description" : "The id of the extension bundle this version is for" + }, + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket the extension bundle belongs to" + }, + "version" : { + "type" : "string", + "description" : "The version of the extension bundle" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the create date of this version", + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The identity that created this version" + }, + "description" : { + "type" : "string", + "description" : "The description for this version" + }, + "sha256" : { + "type" : "string", + "description" : "The hex representation of the SHA-256 digest of the binary content for this version" + }, + "sha256Supplied" : { + "type" : "boolean", + "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" + }, + "contentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the binary content for this version in bytes", + "minimum" : 0 + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API that this bundle version was built against" + }, + "buildInfo" : { + "description" : "The build information about this version", + "$ref" : "#/definitions/BuildInfo" + } + } + }, + "ComponentDifference" : { + "type" : "object", + "properties" : { + "valueA" : { + "type" : "string", + "description" : "The earlier value from the difference." + }, + "valueB" : { + "type" : "string", + "description" : "The newer value from the difference." + }, + "changeDescription" : { + "type" : "string", + "description" : "The description of the change." + }, + "differenceType" : { + "type" : "string", + "description" : "The key to the difference." + }, + "differenceTypeDescription" : { + "type" : "string", + "description" : "The description of the change type." + } + } + }, + "ComponentDifferenceGroup" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The id of the component whose changes are grouped together." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component whose changes are grouped together." + }, + "componentType" : { + "type" : "string", + "description" : "The type of component these changes relate to." + }, + "processGroupId" : { + "type" : "string", + "description" : "The process group id for this component." + }, + "differences" : { + "type" : "array", + "description" : "The list of changes related to this component between the 2 versions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifference" + } + } + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceDefinition" : { + "type" : "object", + "properties" : { + "className" : { + "type" : "string", + "description" : "The class name of the service API" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API" + } + } + }, + "CurrentUser" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The identity of the current user", + "readOnly" : true + }, + "anonymous" : { + "type" : "boolean", + "description" : "Indicates if the current user is anonymous", + "readOnly" : true + }, + "loginSupported" : { + "type" : "boolean", + "description" : "Indicates if the NiFi instance supports logging in" + }, + "resourcePermissions" : { + "description" : "The access that the current user has to top level resources", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + } + } + }, + "DeprecationNotice" : { + "type" : "object", + "properties" : { + "reason" : { + "type" : "string", + "description" : "The reason for the deprecation" + }, + "alternatives" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The alternatives to use", + "items" : { + "type" : "string", + "xml" : { + "name" : "alternative" + } + } + } + } + }, + "DynamicProperty" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic property name" + }, + "value" : { + "type" : "string", + "description" : "The description of the dynamic property value" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic property" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of the expression language support", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + } + } + }, + "DynamicRelationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic relationship name" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic relationship" + } + } + }, + "Extension" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "deprecationNotice" : { + "description" : "The deprecation notice of the extension", + "$ref" : "#/definitions/DeprecationNotice" + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "tags" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The tags of the extension", + "items" : { + "type" : "string", + "xml" : { + "name" : "tag" + } + } + }, + "properties" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The properties of the extension", + "items" : { + "xml" : { + "name" : "property" + }, + "$ref" : "#/definitions/Property" + } + }, + "dynamicProperties" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The dynamic properties of the extension", + "items" : { + "xml" : { + "name" : "dynamicProperty" + }, + "$ref" : "#/definitions/DynamicProperty" + } + }, + "relationships" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The relationships of the extension", + "items" : { + "xml" : { + "name" : "relationship" + }, + "$ref" : "#/definitions/Relationship" + } + }, + "dynamicRelationship" : { + "description" : "The dynamic relationships of the extension", + "$ref" : "#/definitions/DynamicRelationship" + }, + "readsAttributes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The attributes read from flow files by the extension", + "items" : { + "xml" : { + "name" : "readsAttribute" + }, + "$ref" : "#/definitions/Attribute" + } + }, + "writesAttributes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The attributes written to flow files by the extension", + "items" : { + "xml" : { + "name" : "writesAttribute" + }, + "$ref" : "#/definitions/Attribute" + } + }, + "stateful" : { + "description" : "The information about how the extension stores state", + "$ref" : "#/definitions/Stateful" + }, + "restricted" : { + "description" : "The restrictions of the extension", + "$ref" : "#/definitions/Restricted" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement of the extension", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "systemResourceConsiderations" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The resource considerations of the extension", + "items" : { + "xml" : { + "name" : "systemResourceConsideration" + }, + "$ref" : "#/definitions/SystemResourceConsideration" + } + }, + "seeAlso" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The names of other extensions to see", + "items" : { + "type" : "string", + "xml" : { + "name" : "see" + } + } + }, + "providedServiceAPIs" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The service APIs provided by this extension", + "items" : { + "xml" : { + "name" : "providedServiceAPI" + }, + "$ref" : "#/definitions/ProvidedServiceAPI" + } + } + } + }, + "ExtensionBundle" : { + "type" : "object", + "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "bundleType" : { + "type" : "string", + "description" : "The type of the extension bundle", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the extension bundle" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the extension bundle" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this extension bundle.", + "readOnly" : true, + "minimum" : 0 + } + } + }, + "ExtensionFilterParams" : { + "type" : "object", + "properties" : { + "bundleType" : { + "type" : "string", + "description" : "The type of bundle", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "extensionType" : { + "type" : "string", + "description" : "The type of extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "tags" : { + "type" : "array", + "description" : "The tags", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ExtensionMetadata" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the extension" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "deprecationNotice" : { + "description" : "The deprecation notice of the extension", + "$ref" : "#/definitions/DeprecationNotice" + }, + "tags" : { + "type" : "array", + "description" : "The tags of the extension", + "items" : { + "type" : "string" + } + }, + "restricted" : { + "description" : "The restrictions of the extension", + "$ref" : "#/definitions/Restricted" + }, + "providedServiceAPIs" : { + "type" : "array", + "description" : "The service APIs provided by the extension", + "items" : { + "$ref" : "#/definitions/ProvidedServiceAPI" + } + }, + "bundleInfo" : { + "description" : "The information for the bundle where this extension is located", + "$ref" : "#/definitions/BundleInfo" + }, + "hasAdditionalDetails" : { + "type" : "boolean", + "description" : "Whether or not the extension has additional detail documentation" + }, + "linkDocs" : { + "description" : "A WebLink to the documentation for this extension.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + } + } + }, + "ExtensionMetadataContainer" : { + "type" : "object", + "properties" : { + "numResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extensions in the response" + }, + "filterParams" : { + "description" : "The filter parameters submitted for the request", + "$ref" : "#/definitions/ExtensionFilterParams" + }, + "extensions" : { + "type" : "array", + "description" : "The metadata for the extensions", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + } + }, + "ExtensionRepoArtifact" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + } + } + }, + "ExtensionRepoBucket" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket" + } + } + }, + "ExtensionRepoGroup" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + } + } + }, + "ExtensionRepoVersion" : { + "type" : "object", + "properties" : { + "extensionsLink" : { + "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "downloadLink" : { + "description" : "The WebLink to download this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "sha256Link" : { + "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "sha256Supplied" : { + "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + } + } + }, + "ExtensionRepoVersionSummary" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + }, + "version" : { + "type" : "string", + "description" : "The version" + }, + "author" : { + "type" : "string", + "description" : "The identity of the user that created this version" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when this version was created" + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "Fields" : { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "JaxbLink" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "format" : "uri", + "xml" : { + "attribute" : true + }, + "description" : "The href for the link" + }, + "params" : { + "type" : "object", + "description" : "The params for the link", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "Permissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + } + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "Property" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name" + }, + "description" : { + "type" : "string", + "description" : "The description" + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value" + }, + "controllerServiceDefinition" : { + "description" : "The controller service required by this property, or null if none is required", + "$ref" : "#/definitions/ControllerServiceDefinition" + }, + "allowableValues" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The allowable values for this property", + "items" : { + "xml" : { + "name" : "allowableValue" + }, + "$ref" : "#/definitions/AllowableValue" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is sensitive" + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of expression language support", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + }, + "dynamicallyModifiesClasspath" : { + "type" : "boolean", + "description" : "Whether or not the processor dynamically modifies the classpath" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the processor is dynamic" + } + } + }, + "ProvidedServiceAPI" : { + "type" : "object", + "properties" : { + "className" : { + "type" : "string", + "description" : "The class name of the service API being provided" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API being provided" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API being provided" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API being provided" + } + } + }, + "RegistryConfiguration" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports configurable users and groups.", + "readOnly" : true + } + } + }, + "Relationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the relationship" + }, + "description" : { + "type" : "string", + "description" : "The description of the relationship" + }, + "autoTerminated" : { + "type" : "boolean", + "description" : "Whether or not the relationship is auto-terminated by default" + } + } + }, + "Resource" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the resource.", + "readOnly" : true + } + } + }, + "ResourcePermissions" : { + "type" : "object", + "properties" : { + "buckets" : { + "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "tenants" : { + "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "policies" : { + "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "proxy" : { + "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "anyTopLevelResource" : { + "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "Restricted" : { + "type" : "object", + "properties" : { + "generalRestrictionExplanation" : { + "type" : "string", + "description" : "The general restriction for the extension, or null if only specific restrictions exist" + }, + "restrictions" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The specific restrictions", + "items" : { + "xml" : { + "name" : "restriction" + }, + "$ref" : "#/definitions/Restriction" + } + } + } + }, + "Restriction" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "type" : "string", + "description" : "The permission required for this restriction" + }, + "explanation" : { + "type" : "string", + "description" : "The explanation of this restriction" + } + } + }, + "Stateful" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description for how the extension stores state" + }, + "scopes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The scopes used to store state", + "items" : { + "type" : "string", + "xml" : { + "name" : "scope" + }, + "enum" : [ "CLUSTER", "LOCAL" ] + } + } + } + }, + "SystemResourceConsideration" : { + "type" : "object", + "properties" : { + "resource" : { + "type" : "string", + "description" : "The resource to consider" + }, + "description" : { + "type" : "string", + "description" : "The description of how the resource is affected" + } + } + }, + "TagCount" : { + "type" : "object", + "properties" : { + "tag" : { + "type" : "string", + "description" : "The tag label" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of occurrences of the given tag" + } + } + }, + "Tenant" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + } + } + }, + "User" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "UserGroup" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "users" : { + "type" : "array", + "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "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." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/Bundle" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "readOnly" : true, + "minimum" : 0 + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDifference" : { + "type" : "object", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket that the flow is stored in." + }, + "flowId" : { + "type" : "string", + "description" : "The id of the flow that is being examined." + }, + "versionA" : { + "type" : "integer", + "format" : "int32", + "description" : "The earlier version from the diff operation." + }, + "versionB" : { + "type" : "integer", + "format" : "int32", + "description" : "The latter version from the diff operation." + }, + "componentDifferenceGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceGroup" + } + } + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "required" : [ "flowContents", "snapshotMetadata" ], + "properties" : { + "snapshotMetadata" : { + "description" : "The metadata for this snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "flowContents" : { + "description" : "The contents of the versioned flow", + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterContexts" : { + "type" : "object", + "description" : "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.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "flow" : { + "description" : "The flow this snapshot is for", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlow" + }, + "bucket" : { + "description" : "The bucket where the flow is located", + "readOnly" : true, + "$ref" : "#/definitions/Bucket" + }, + "latest" : { + "type" : "boolean" + } + } + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to." + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "readOnly" : true + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + } + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the context" + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "The type of Processor" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + } + } +} diff --git a/resources/client_gen/generate_api_client.sh b/resources/client_gen/generate_api_client.sh index 7e5f2996..50657875 100755 --- a/resources/client_gen/generate_api_client.sh +++ b/resources/client_gen/generate_api_client.sh @@ -8,7 +8,7 @@ # Params echo Exporting Params -export wv_client_name=${wv_client_name:-nifi} +export wv_client_name=${wv_client_name:-registry} export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-2.3.1.jar} export wv_tmp_dir=${wv_tmp_dir:-${HOME}/Projects/tmp} diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index 8311c8c9..fa6b435d 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,13 +2,13 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.9.1 + image: apache/nifi:1.9.2 container_name: nifi hostname: nifi ports: - "8080:8080" registry: - image: apache/nifi-registry:0.3.0 + image: apache/nifi-registry:0.5.0 container_name: registry hostname: registry ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index 0ecfc80e..f84b8854 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.1' services: secure-nifi: - image: apache/nifi:1.9.1 + image: apache/nifi:1.9.2 container_name: secure-nifi hostname: secure-nifi ports: @@ -25,7 +25,7 @@ services: - LDAP_IDENTITY_STRATEGY=USE_USERNAME - LDAP_URL=ldap://ldap.forumsys.com:389 secure-registry: - image: apache/nifi-registry:0.3.0 + image: apache/nifi-registry:0.5.0 container_name: secure-registry hostname: secure-registry ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index 2497ef3a..b96dac63 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -19,7 +19,7 @@ services: ports: - "10180:8080" nifi: - image: apache/nifi:1.9.1 + image: apache/nifi:1.9.2 container_name: nifi hostname: nifi ports: @@ -33,7 +33,7 @@ services: environment: - NIFI_REGISTRY_WEB_HTTP_PORT=18010 registry: - image: apache/nifi-registry:0.3.0 + image: apache/nifi-registry:0.5.0 container_name: registry hostname: registry ports: From 17589724282ae0d567f1aadd7e094c2a5ba4d5bf Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 9 Oct 2019 17:10:29 +0100 Subject: [PATCH 10/40] Preparing for 0.13.3 release --- docs/history.rst | 8 ++++++++ setup.py | 4 ++-- tests/conftest.py | 4 ++-- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/history.rst b/docs/history.rst index d8d2720a..a68a6c92 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,14 @@ History ======= +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) ------------------- diff --git a/setup.py b/setup.py index a9696a5f..4e4137c5 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ with open('docs/history.rst') as history_file: history = history_file.read() -proj_version = '0.13.2' +proj_version = '0.13.3' with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() @@ -47,7 +47,7 @@ "Programming Language :: Python :: 2", 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', 'Topic :: Software Development :: User Interfaces' ], test_suite='tests' diff --git a/tests/conftest.py b/tests/conftest.py index a45e8b5f..3528718e 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -14,8 +14,8 @@ # Test Suite Controls test_default = True # Default to True for release -test_security = False # Default to False for release -test_regression = False # Default to False for release +test_security = True # Default to False for release +test_regression = True # Default to False for release # Test Configuration parameters test_host = nipyapi.config.default_host From b4dd54e9b23d5f48a109e658eece682858bcd812 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 9 Oct 2019 17:10:46 +0100 Subject: [PATCH 11/40] Preparing for 0.13.3 release --- tests/conftest.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/conftest.py b/tests/conftest.py index 3528718e..a45e8b5f 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -14,8 +14,8 @@ # Test Suite Controls test_default = True # Default to True for release -test_security = True # Default to False for release -test_regression = True # Default to False for release +test_security = False # Default to False for release +test_regression = False # Default to False for release # Test Configuration parameters test_host = nipyapi.config.default_host From adc71cbc6a9d0fcf921da8335b5f8e1d6f2d1add Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 9 Oct 2019 17:11:54 +0100 Subject: [PATCH 12/40] =?UTF-8?q?Bump=20version:=200.13.2=20=E2=86=92=200.?= =?UTF-8?q?13.3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- nipyapi/__init__.py | 2 +- setup.cfg | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index cc0ee315..242bdca0 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.13.2' +__version__ = '0.13.3' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security'] diff --git a/setup.cfg b/setup.cfg index 7fb667d6..7b727c2e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.13.2 +current_version = 0.13.3 commit = True tag = True From 859945a225d6c9b5c36d44315aec8dfe98790bee Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 9 Oct 2019 17:35:05 +0100 Subject: [PATCH 13/40] Update devnotes for working within pyenv --- docs/devnotes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/devnotes.rst b/docs/devnotes.rst index e6c5d5cb..333b70e5 100644 --- a/docs/devnotes.rst +++ b/docs/devnotes.rst @@ -119,7 +119,7 @@ This assumes you have virtualenvwrapper, git, and appropriate python versions in python setup.py build_sphinx # check docs in build/sphinx/html/index.html python setup.py sdist bdist_wheel - mktmpenv + 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 From bf29c448d7d8485a501c90f04f40509dbdae5edb Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Tue, 8 Oct 2019 10:47:51 +0100 Subject: [PATCH 14/40] Fixes #155 --- tests/test_canvas.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/test_canvas.py b/tests/test_canvas.py index c7d80ba4..1ff3ce9b 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -332,6 +332,7 @@ def test_update_variable_registry(fix_pg): _ = canvas.update_variable_registry(test_pg, '') + def test_purge_connection(): # TODO: Waiting for create_connection to generate fixture pass From 59e31f26d1fcf73f2ac82d3deee5cadf51810ae0 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 16 Oct 2019 15:44:56 +0100 Subject: [PATCH 15/40] Added functionality to create/delete/enable/disable remote process groups --- nipyapi/canvas.py | 86 +++++++++++++++++++++++++++++++++++++++++++- tests/conftest.py | 8 +++++ tests/test_canvas.py | 14 ++++++++ 3 files changed, 107 insertions(+), 1 deletion(-) diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index a163f0eb..7a2779de 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -24,7 +24,9 @@ 'schedule_controller', 'get_controller', 'list_all_controller_types', 'list_all_by_kind', 'list_all_input_ports', 'list_all_output_ports', 'list_all_funnels', 'list_all_remote_process_groups', 'delete_funnel', - 'get_remote_process_group', 'update_process_group', 'create_funnel' + 'get_remote_process_group', 'update_process_group', 'create_funnel', + 'create_remote_process_group', 'delete_remote_process_group', + 'set_remote_process_group_transmission' ] log = logging.getLogger(__name__) @@ -1336,6 +1338,88 @@ def get_remote_process_group(rpg_id, summary=False): return out +def create_remote_process_group(target_uris, transport='RAW', pg_id='root', position=None): + """ + Creates a new Remote Process Group with given parameters + + Args: + 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) + """ + assert isinstance(target_uris, str) + assert transport in ['RAW', 'HTTP'] + assert isinstance(pg_id, str) + pg_id = pg_id if not 'root' else get_root_pg_id() + position = position if position else (400, 400) + assert isinstance(position, tuple) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.ProcessGroupsApi().create_remote_process_group( + id=pg_id, + body=nipyapi.nifi.RemoteProcessGroupEntity( + component=nipyapi.nifi.RemoteProcessGroupDTO( + position=nipyapi.nifi.PositionDTO( + x=float(position[0]), + y=float(position[1]) + ), + target_uris=target_uris, + transport_protocol=transport + ), + revision=nipyapi.nifi.RevisionDTO(version=0), + ) + ) + + +def delete_remote_process_group(rpg, refresh=True): + """ + Deletes a given remote process group + + Args: + rpg (RemoteProcessGroupEntity): Remote Process Group to remove + refresh (bool): Whether to refresh the object before action + + Returns: + (RemoteProcessGroupEntity) + """ + assert isinstance(rpg, nipyapi.nifi.RemoteProcessGroupEntity) + if refresh: + rpg = get_remote_process_group(rpg.id) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.RemoteProcessGroupsApi().remove_remote_process_group( + id=rpg.id, + version=rpg.revision.version + ) + + +def set_remote_process_group_transmission(rpg, enable=True, refresh=True): + """ + + Args: + 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: + + """ + assert isinstance(rpg, nipyapi.nifi.RemoteProcessGroupEntity) + assert isinstance(enable, bool) + if refresh: + rpg = get_remote_process_group(rpg.id) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.RemoteProcessGroupsApi().update_remote_process_group_run_status( + id=rpg.id, + body=nipyapi.nifi.RemotePortRunStatusEntity( + state='TRANSMITTING' if enable else 'STOPPED', + revision=rpg.revision + ) + ) + + def create_port(pg_id, port_type, name, state, position=None): """ Creates a new input or output port of given characteristics diff --git a/tests/conftest.py b/tests/conftest.py index a45e8b5f..0e4dcc50 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -330,11 +330,19 @@ def cleanup_nifi(): remove_test_processors() remove_test_ports() remove_test_funnels() + remove_test_rpgs() if test_security and 'https' in nipyapi.nifi.configuration.host: remove_test_service_user_groups('nifi') remove_test_service_users('nifi') +def remove_test_rpgs(): + _ = [ + nipyapi.canvas.delete_remote_process_group(x) + for x in nipyapi.canvas.list_all_remote_process_groups() + ] + + def remove_test_connections(): # Funnels don't have a name, have to go by type _ = [ diff --git a/tests/test_canvas.py b/tests/test_canvas.py index 1ff3ce9b..dcf16d35 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -651,3 +651,17 @@ def test_client_recursion_limit(fix_pg, fix_funnel, target=450): print("Len {0} Set {1}".format(len(r1), len(set([x.id for x in r1])))) print("Elapsed r1: {0}".format((end - start))) + +def test_remote_process_group_controls(): + rpg1 = canvas.create_remote_process_group('http://localhost:8080/nifi') + assert isinstance(rpg1, nifi.RemoteProcessGroupEntity) + assert rpg1.revision is not None + r1 = canvas.set_remote_process_group_transmission(rpg1) + assert isinstance(r1, nifi.RemoteProcessGroupEntity) + assert r1.status.transmission_status == 'Transmitting' + r2 = canvas.set_remote_process_group_transmission(rpg1, False) + assert isinstance(r2, nifi.RemoteProcessGroupEntity) + assert r2.status.transmission_status == 'NotTransmitting' + r3 = canvas.delete_remote_process_group(rpg1) + assert isinstance(r3, nifi.RemoteProcessGroupEntity) + assert r3.revision is None From 2d420661a7f8014659b6649e8aaf7acd9a94bb9b Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 6 Nov 2019 13:39:18 +0000 Subject: [PATCH 16/40] Updated NiFi client to support 1.10.0 Updated versioning.save_flow_to_registry for 1.10 compatibility Updated Docker Compose helpers to latest version Updated Readme --- README.rst | 2 +- nipyapi/nifi/__init__.py | 31 +- nipyapi/nifi/api_client.py | 2 +- nipyapi/nifi/apis/__init__.py | 1 + nipyapi/nifi/apis/access_api.py | 100 +- nipyapi/nifi/apis/connections_api.py | 2 +- nipyapi/nifi/apis/controller_api.py | 2 +- nipyapi/nifi/apis/controller_services_api.py | 2 +- nipyapi/nifi/apis/counters_api.py | 2 +- nipyapi/nifi/apis/data_transfer_api.py | 2 +- nipyapi/nifi/apis/flow_api.py | 214 +- nipyapi/nifi/apis/flowfile_queues_api.py | 2 +- nipyapi/nifi/apis/funnel_api.py | 2 +- nipyapi/nifi/apis/input_ports_api.py | 2 +- nipyapi/nifi/apis/labels_api.py | 2 +- nipyapi/nifi/apis/output_ports_api.py | 2 +- nipyapi/nifi/apis/parameter_contexts_api.py | 1170 + nipyapi/nifi/apis/policies_api.py | 2 +- nipyapi/nifi/apis/process_groups_api.py | 2 +- nipyapi/nifi/apis/processors_api.py | 2 +- nipyapi/nifi/apis/provenance_api.py | 2 +- nipyapi/nifi/apis/provenance_events_api.py | 2 +- .../nifi/apis/remote_process_groups_api.py | 108 +- nipyapi/nifi/apis/reporting_tasks_api.py | 2 +- nipyapi/nifi/apis/resources_api.py | 2 +- nipyapi/nifi/apis/site_to_site_api.py | 2 +- nipyapi/nifi/apis/snippets_api.py | 2 +- nipyapi/nifi/apis/system_diagnostics_api.py | 2 +- nipyapi/nifi/apis/templates_api.py | 2 +- nipyapi/nifi/apis/tenants_api.py | 2 +- nipyapi/nifi/apis/versions_api.py | 2 +- nipyapi/nifi/configuration.py | 4 +- nipyapi/nifi/models/__init__.py | 30 +- nipyapi/nifi/models/about_dto.py | 2 +- nipyapi/nifi/models/about_entity.py | 2 +- .../nifi/models/access_configuration_dto.py | 2 +- .../models/access_configuration_entity.py | 2 +- nipyapi/nifi/models/access_policy_dto.py | 2 +- nipyapi/nifi/models/access_policy_entity.py | 2 +- .../nifi/models/access_policy_summary_dto.py | 2 +- .../models/access_policy_summary_entity.py | 2 +- nipyapi/nifi/models/access_status_dto.py | 2 +- nipyapi/nifi/models/access_status_entity.py | 2 +- nipyapi/nifi/models/action_details_dto.py | 2 +- nipyapi/nifi/models/action_dto.py | 2 +- nipyapi/nifi/models/action_entity.py | 2 +- .../activate_controller_services_entity.py | 2 +- nipyapi/nifi/models/affected_component_dto.py | 2 +- .../nifi/models/affected_component_entity.py | 70 +- nipyapi/nifi/models/allowable_value_dto.py | 2 +- nipyapi/nifi/models/allowable_value_entity.py | 2 +- nipyapi/nifi/models/attribute_dto.py | 2 +- nipyapi/nifi/models/banner_dto.py | 2 +- nipyapi/nifi/models/banner_entity.py | 2 +- nipyapi/nifi/models/batch_settings_dto.py | 2 +- nipyapi/nifi/models/batch_size.py | 2 +- nipyapi/nifi/models/bucket.py | 66 +- nipyapi/nifi/models/bucket_dto.py | 2 +- nipyapi/nifi/models/bucket_entity.py | 2 +- nipyapi/nifi/models/buckets_entity.py | 2 +- nipyapi/nifi/models/bulletin_board_dto.py | 2 +- nipyapi/nifi/models/bulletin_board_entity.py | 2 +- nipyapi/nifi/models/bulletin_dto.py | 2 +- nipyapi/nifi/models/bulletin_entity.py | 2 +- nipyapi/nifi/models/bundle.py | 2 +- nipyapi/nifi/models/bundle_dto.py | 2 +- nipyapi/nifi/models/cluste_summary_entity.py | 2 +- nipyapi/nifi/models/cluster_dto.py | 2 +- nipyapi/nifi/models/cluster_entity.py | 2 +- .../models/cluster_search_results_entity.py | 2 +- nipyapi/nifi/models/cluster_summary_dto.py | 2 +- nipyapi/nifi/models/component_details_dto.py | 2 +- .../nifi/models/component_difference_dto.py | 2 +- nipyapi/nifi/models/component_history_dto.py | 2 +- .../nifi/models/component_history_entity.py | 2 +- .../nifi/models/component_reference_dto.py | 2 +- .../nifi/models/component_reference_entity.py | 2 +- .../component_restriction_permission_dto.py | 2 +- .../models/component_search_result_dto.py | 2 +- nipyapi/nifi/models/component_state_dto.py | 2 +- nipyapi/nifi/models/component_state_entity.py | 2 +- .../models/component_validation_result_dto.py | 383 + .../component_validation_result_entity.py | 319 + .../component_validation_results_entity.py | 125 + nipyapi/nifi/models/connectable_component.py | 2 +- nipyapi/nifi/models/connectable_dto.py | 2 +- nipyapi/nifi/models/connection_dto.py | 2 +- nipyapi/nifi/models/connection_entity.py | 2 +- .../nifi/models/connection_statistics_dto.py | 209 + .../models/connection_statistics_entity.py | 151 + .../connection_statistics_snapshot_dto.py | 321 + nipyapi/nifi/models/connection_status_dto.py | 2 +- .../nifi/models/connection_status_entity.py | 2 +- ...nection_status_predictions_snapshot_dto.py | 293 + .../models/connection_status_snapshot_dto.py | 32 +- .../connection_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/connections_entity.py | 2 +- .../models/controller_bulletins_entity.py | 2 +- .../models/controller_configuration_dto.py | 2 +- .../models/controller_configuration_entity.py | 2 +- nipyapi/nifi/models/controller_dto.py | 2 +- nipyapi/nifi/models/controller_entity.py | 2 +- nipyapi/nifi/models/controller_service_api.py | 2 +- .../nifi/models/controller_service_api_dto.py | 2 +- nipyapi/nifi/models/controller_service_dto.py | 2 +- .../nifi/models/controller_service_entity.py | 2 +- ...oller_service_referencing_component_dto.py | 3 +- ...er_service_referencing_component_entity.py | 2 +- ...r_service_referencing_components_entity.py | 2 +- .../controller_service_run_status_entity.py | 2 +- .../models/controller_service_status_dto.py | 2 +- .../models/controller_service_types_entity.py | 2 +- .../nifi/models/controller_services_entity.py | 2 +- nipyapi/nifi/models/controller_status_dto.py | 2 +- .../nifi/models/controller_status_entity.py | 2 +- .../models/copy_snippet_request_entity.py | 2 +- nipyapi/nifi/models/counter_dto.py | 2 +- nipyapi/nifi/models/counter_entity.py | 2 +- nipyapi/nifi/models/counters_dto.py | 2 +- nipyapi/nifi/models/counters_entity.py | 2 +- nipyapi/nifi/models/counters_snapshot_dto.py | 2 +- .../models/create_active_request_entity.py | 2 +- .../models/create_template_request_entity.py | 2 +- nipyapi/nifi/models/current_user_entity.py | 32 +- nipyapi/nifi/models/difference_dto.py | 2 +- nipyapi/nifi/models/dimensions_dto.py | 2 +- nipyapi/nifi/models/documented_type_dto.py | 2 +- nipyapi/nifi/models/drop_request_dto.py | 2 +- nipyapi/nifi/models/drop_request_entity.py | 2 +- .../nifi/models/explicit_restriction_dto.py | 2 +- .../external_controller_service_reference.py | 153 + nipyapi/nifi/models/flow_breadcrumb_dto.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_entity.py | 2 +- nipyapi/nifi/models/flow_comparison_entity.py | 2 +- nipyapi/nifi/models/flow_configuration_dto.py | 2 +- .../nifi/models/flow_configuration_entity.py | 2 +- nipyapi/nifi/models/flow_dto.py | 2 +- nipyapi/nifi/models/flow_entity.py | 2 +- nipyapi/nifi/models/flow_file_dto.py | 2 +- nipyapi/nifi/models/flow_file_entity.py | 2 +- nipyapi/nifi/models/flow_file_summary_dto.py | 2 +- nipyapi/nifi/models/flow_snippet_dto.py | 2 +- nipyapi/nifi/models/funnel_dto.py | 2 +- nipyapi/nifi/models/funnel_entity.py | 2 +- nipyapi/nifi/models/funnels_entity.py | 2 +- nipyapi/nifi/models/garbage_collection_dto.py | 2 +- nipyapi/nifi/models/history_dto.py | 2 +- nipyapi/nifi/models/history_entity.py | 2 +- nipyapi/nifi/models/input_ports_entity.py | 2 +- .../instantiate_template_request_entity.py | 2 +- .../models/{uri_builder.py => jaxb_link.py} | 68 +- nipyapi/nifi/models/label_dto.py | 2 +- nipyapi/nifi/models/label_entity.py | 2 +- nipyapi/nifi/models/labels_entity.py | 2 +- nipyapi/nifi/models/lineage_dto.py | 2 +- nipyapi/nifi/models/lineage_entity.py | 2 +- nipyapi/nifi/models/lineage_request_dto.py | 2 +- nipyapi/nifi/models/lineage_results_dto.py | 2 +- nipyapi/nifi/models/link.py | 279 - nipyapi/nifi/models/listing_request_dto.py | 2 +- nipyapi/nifi/models/listing_request_entity.py | 2 +- ...node_connection_statistics_snapshot_dto.py | 209 + .../node_connection_status_snapshot_dto.py | 2 +- .../nifi/models/node_counters_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_dto.py | 2 +- nipyapi/nifi/models/node_entity.py | 2 +- nipyapi/nifi/models/node_event_dto.py | 2 +- .../models/node_port_status_snapshot_dto.py | 2 +- .../node_process_group_status_snapshot_dto.py | 2 +- .../node_processor_status_snapshot_dto.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_search_result_dto.py | 2 +- .../nifi/models/node_status_snapshots_dto.py | 2 +- .../node_system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/output_ports_entity.py | 2 +- nipyapi/nifi/models/parameter_context_dto.py | 237 + .../nifi/models/parameter_context_entity.py | 321 + .../models/parameter_context_reference_dto.py | 153 + .../parameter_context_reference_entity.py | 179 + .../parameter_context_update_request_dto.py | 405 + ...parameter_context_update_request_entity.py | 153 + .../parameter_context_update_step_dto.py | 181 + ...arameter_context_validation_request_dto.py | 405 + ...meter_context_validation_request_entity.py | 153 + .../parameter_context_validation_step_dto.py | 181 + .../nifi/models/parameter_contexts_entity.py | 153 + nipyapi/nifi/models/parameter_dto.py | 237 + nipyapi/nifi/models/parameter_entity.py | 153 + nipyapi/nifi/models/peer_dto.py | 2 +- nipyapi/nifi/models/peers_entity.py | 2 +- nipyapi/nifi/models/permissions.py | 2 +- nipyapi/nifi/models/permissions_dto.py | 2 +- nipyapi/nifi/models/port_dto.py | 36 +- nipyapi/nifi/models/port_entity.py | 36 +- nipyapi/nifi/models/port_run_status_entity.py | 2 +- nipyapi/nifi/models/port_status_dto.py | 2 +- nipyapi/nifi/models/port_status_entity.py | 2 +- .../nifi/models/port_status_snapshot_dto.py | 2 +- .../models/port_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/position.py | 2 +- nipyapi/nifi/models/position_dto.py | 2 +- nipyapi/nifi/models/previous_value_dto.py | 2 +- .../nifi/models/prioritizer_types_entity.py | 2 +- nipyapi/nifi/models/process_group_dto.py | 202 +- nipyapi/nifi/models/process_group_entity.py | 144 +- nipyapi/nifi/models/process_group_flow_dto.py | 32 +- .../nifi/models/process_group_flow_entity.py | 2 +- nipyapi/nifi/models/process_group_name_dto.py | 153 + .../nifi/models/process_group_status_dto.py | 2 +- .../models/process_group_status_entity.py | 2 +- .../process_group_status_snapshot_dto.py | 2 +- .../process_group_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/process_groups_entity.py | 2 +- nipyapi/nifi/models/processor_config_dto.py | 2 +- nipyapi/nifi/models/processor_dto.py | 2 +- nipyapi/nifi/models/processor_entity.py | 2 +- .../models/processor_run_status_entity.py | 2 +- nipyapi/nifi/models/processor_status_dto.py | 2 +- .../nifi/models/processor_status_entity.py | 2 +- .../models/processor_status_snapshot_dto.py | 2 +- .../processor_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/processor_types_entity.py | 2 +- nipyapi/nifi/models/processors_entity.py | 2 +- .../nifi/models/property_descriptor_dto.py | 2 +- .../nifi/models/property_descriptor_entity.py | 2 +- nipyapi/nifi/models/property_history_dto.py | 2 +- nipyapi/nifi/models/provenance_dto.py | 2 +- nipyapi/nifi/models/provenance_entity.py | 2 +- nipyapi/nifi/models/provenance_event_dto.py | 2 +- .../nifi/models/provenance_event_entity.py | 2 +- nipyapi/nifi/models/provenance_link_dto.py | 2 +- nipyapi/nifi/models/provenance_node_dto.py | 2 +- nipyapi/nifi/models/provenance_options_dto.py | 2 +- .../nifi/models/provenance_options_entity.py | 2 +- nipyapi/nifi/models/provenance_request_dto.py | 2 +- nipyapi/nifi/models/provenance_results_dto.py | 2 +- .../models/provenance_searchable_field_dto.py | 2 +- nipyapi/nifi/models/queue_size_dto.py | 2 +- nipyapi/nifi/models/registry_client_entity.py | 2 +- .../nifi/models/registry_clients_entity.py | 2 +- nipyapi/nifi/models/registry_dto.py | 2 +- nipyapi/nifi/models/relationship_dto.py | 2 +- .../models/remote_port_run_status_entity.py | 2 +- .../remote_process_group_contents_dto.py | 2 +- .../nifi/models/remote_process_group_dto.py | 2 +- .../models/remote_process_group_entity.py | 2 +- .../models/remote_process_group_port_dto.py | 2 +- .../remote_process_group_port_entity.py | 2 +- .../models/remote_process_group_status_dto.py | 2 +- .../remote_process_group_status_entity.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- ...te_process_group_status_snapshot_entity.py | 2 +- .../models/remote_process_groups_entity.py | 2 +- nipyapi/nifi/models/reporting_task_dto.py | 2 +- nipyapi/nifi/models/reporting_task_entity.py | 2 +- .../reporting_task_run_status_entity.py | 2 +- .../nifi/models/reporting_task_status_dto.py | 2 +- .../models/reporting_task_types_entity.py | 2 +- nipyapi/nifi/models/reporting_tasks_entity.py | 2 +- .../nifi/models/required_permission_dto.py | 2 +- nipyapi/nifi/models/resource_dto.py | 2 +- nipyapi/nifi/models/resources_entity.py | 2 +- nipyapi/nifi/models/revision_dto.py | 2 +- .../nifi/models/schedule_components_entity.py | 2 +- .../nifi/models/search_result_group_dto.py | 2 +- nipyapi/nifi/models/search_results_dto.py | 64 +- nipyapi/nifi/models/search_results_entity.py | 2 +- nipyapi/nifi/models/snippet_dto.py | 2 +- nipyapi/nifi/models/snippet_entity.py | 2 +- .../start_version_control_request_entity.py | 2 +- nipyapi/nifi/models/state_entry_dto.py | 2 +- nipyapi/nifi/models/state_map_dto.py | 2 +- nipyapi/nifi/models/status_descriptor_dto.py | 2 +- nipyapi/nifi/models/status_history_dto.py | 2 +- nipyapi/nifi/models/status_history_entity.py | 2 +- nipyapi/nifi/models/status_snapshot_dto.py | 2 +- nipyapi/nifi/models/storage_usage_dto.py | 2 +- nipyapi/nifi/models/streaming_output.py | 2 +- .../models/submit_replay_request_entity.py | 2 +- nipyapi/nifi/models/system_diagnostics_dto.py | 2 +- .../nifi/models/system_diagnostics_entity.py | 2 +- .../models/system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/template_dto.py | 2 +- nipyapi/nifi/models/template_entity.py | 2 +- nipyapi/nifi/models/templates_entity.py | 2 +- nipyapi/nifi/models/tenant_dto.py | 2 +- nipyapi/nifi/models/tenant_entity.py | 2 +- nipyapi/nifi/models/tenants_entity.py | 2 +- .../nifi/models/transaction_result_entity.py | 2 +- ...roller_service_reference_request_entity.py | 2 +- nipyapi/nifi/models/user_dto.py | 2 +- nipyapi/nifi/models/user_entity.py | 2 +- nipyapi/nifi/models/user_group_dto.py | 2 +- nipyapi/nifi/models/user_group_entity.py | 2 +- nipyapi/nifi/models/user_groups_entity.py | 2 +- nipyapi/nifi/models/users_entity.py | 2 +- nipyapi/nifi/models/variable_dto.py | 2 +- nipyapi/nifi/models/variable_entity.py | 2 +- nipyapi/nifi/models/variable_registry_dto.py | 2 +- .../nifi/models/variable_registry_entity.py | 2 +- .../variable_registry_update_request_dto.py | 152 +- ...variable_registry_update_request_entity.py | 2 +- .../variable_registry_update_step_dto.py | 2 +- ...ersion_control_component_mapping_entity.py | 2 +- .../models/version_control_information_dto.py | 2 +- .../version_control_information_entity.py | 2 +- nipyapi/nifi/models/version_info_dto.py | 2 +- nipyapi/nifi/models/versioned_connection.py | 2 +- .../models/versioned_controller_service.py | 2 +- nipyapi/nifi/models/versioned_flow.py | 10 +- .../nifi/models/versioned_flow_coordinates.py | 2 +- nipyapi/nifi/models/versioned_flow_dto.py | 42 +- nipyapi/nifi/models/versioned_flow_entity.py | 2 +- .../nifi/models/versioned_flow_snapshot.py | 88 +- .../models/versioned_flow_snapshot_entity.py | 2 +- .../versioned_flow_snapshot_metadata.py | 12 +- ...versioned_flow_snapshot_metadata_entity.py | 2 +- ...ioned_flow_snapshot_metadata_set_entity.py | 2 +- .../versioned_flow_update_request_dto.py | 2 +- .../versioned_flow_update_request_entity.py | 2 +- nipyapi/nifi/models/versioned_flows_entity.py | 2 +- nipyapi/nifi/models/versioned_funnel.py | 2 +- nipyapi/nifi/models/versioned_label.py | 2 +- nipyapi/nifi/models/versioned_parameter.py | 209 + .../models/versioned_parameter_context.py | 181 + nipyapi/nifi/models/versioned_port.py | 66 +- .../nifi/models/versioned_process_group.py | 32 +- nipyapi/nifi/models/versioned_processor.py | 38 +- .../models/versioned_property_descriptor.py | 2 +- .../models/versioned_remote_group_port.py | 38 +- .../models/versioned_remote_process_group.py | 2 +- nipyapi/nifi/rest.py | 2 +- nipyapi/versioning.py | 3 +- .../api_defs/nifi-1.10.0-swagger.json | 20603 ++++++++++++++++ resources/client_gen/generate_api_client.sh | 2 +- resources/docker/latest/docker-compose.yml | 2 +- resources/docker/secure/docker-compose.yml | 2 +- resources/docker/tox-full/docker-compose.yml | 2 +- 338 files changed, 29271 insertions(+), 714 deletions(-) create mode 100644 nipyapi/nifi/apis/parameter_contexts_api.py create mode 100644 nipyapi/nifi/models/component_validation_result_dto.py create mode 100644 nipyapi/nifi/models/component_validation_result_entity.py create mode 100644 nipyapi/nifi/models/component_validation_results_entity.py create mode 100644 nipyapi/nifi/models/connection_statistics_dto.py create mode 100644 nipyapi/nifi/models/connection_statistics_entity.py create mode 100644 nipyapi/nifi/models/connection_statistics_snapshot_dto.py create mode 100644 nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py create mode 100644 nipyapi/nifi/models/external_controller_service_reference.py rename nipyapi/nifi/models/{uri_builder.py => jaxb_link.py} (64%) delete mode 100644 nipyapi/nifi/models/link.py create mode 100644 nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_reference_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_reference_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_update_request_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_update_request_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_update_step_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_validation_request_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_validation_request_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_validation_step_dto.py create mode 100644 nipyapi/nifi/models/parameter_contexts_entity.py create mode 100644 nipyapi/nifi/models/parameter_dto.py create mode 100644 nipyapi/nifi/models/parameter_entity.py create mode 100644 nipyapi/nifi/models/process_group_name_dto.py create mode 100644 nipyapi/nifi/models/versioned_parameter.py create mode 100644 nipyapi/nifi/models/versioned_parameter_context.py create mode 100644 resources/client_gen/api_defs/nifi-1.10.0-swagger.json diff --git a/README.rst b/README.rst index c120ca0b..49d8f458 100644 --- a/README.rst +++ b/README.rst @@ -97,7 +97,7 @@ Background and Documentation NiFi Version Support -------------------- -| Currently we are testing against NiFi versions 1.1.2 - 1.9.2, and NiFi-Registry versions 0.1.0 - 0.3.0. +| Currently we are testing against NiFi versions 1.1.2 - 1.10, and NiFi-Registry versions 0.1.0 - 0.5.0. | If you find a version compatibility problem please raise an `issue `_ Python Requirements diff --git a/nipyapi/nifi/__init__.py b/nipyapi/nifi/__init__.py index ce0b4d70..b8991446 100644 --- a/nipyapi/nifi/__init__.py +++ b/nipyapi/nifi/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,12 +62,19 @@ from .models.component_search_result_dto import ComponentSearchResultDTO from .models.component_state_dto import ComponentStateDTO from .models.component_state_entity import ComponentStateEntity +from .models.component_validation_result_dto import ComponentValidationResultDTO +from .models.component_validation_result_entity import ComponentValidationResultEntity +from .models.component_validation_results_entity import ComponentValidationResultsEntity from .models.connectable_component import ConnectableComponent from .models.connectable_dto import ConnectableDTO from .models.connection_dto import ConnectionDTO from .models.connection_entity import ConnectionEntity +from .models.connection_statistics_dto import ConnectionStatisticsDTO +from .models.connection_statistics_entity import ConnectionStatisticsEntity +from .models.connection_statistics_snapshot_dto import ConnectionStatisticsSnapshotDTO from .models.connection_status_dto import ConnectionStatusDTO from .models.connection_status_entity import ConnectionStatusEntity +from .models.connection_status_predictions_snapshot_dto import ConnectionStatusPredictionsSnapshotDTO from .models.connection_status_snapshot_dto import ConnectionStatusSnapshotDTO from .models.connection_status_snapshot_entity import ConnectionStatusSnapshotEntity from .models.connections_entity import ConnectionsEntity @@ -104,6 +111,7 @@ from .models.drop_request_dto import DropRequestDTO from .models.drop_request_entity import DropRequestEntity from .models.explicit_restriction_dto import ExplicitRestrictionDTO +from .models.external_controller_service_reference import ExternalControllerServiceReference from .models.flow_breadcrumb_dto import FlowBreadcrumbDTO from .models.flow_breadcrumb_entity import FlowBreadcrumbEntity from .models.flow_comparison_entity import FlowComparisonEntity @@ -123,6 +131,7 @@ from .models.history_entity import HistoryEntity from .models.input_ports_entity import InputPortsEntity from .models.instantiate_template_request_entity import InstantiateTemplateRequestEntity +from .models.jaxb_link import JaxbLink from .models.label_dto import LabelDTO from .models.label_entity import LabelEntity from .models.labels_entity import LabelsEntity @@ -130,9 +139,9 @@ from .models.lineage_entity import LineageEntity from .models.lineage_request_dto import LineageRequestDTO from .models.lineage_results_dto import LineageResultsDTO -from .models.link import Link from .models.listing_request_dto import ListingRequestDTO from .models.listing_request_entity import ListingRequestEntity +from .models.node_connection_statistics_snapshot_dto import NodeConnectionStatisticsSnapshotDTO from .models.node_connection_status_snapshot_dto import NodeConnectionStatusSnapshotDTO from .models.node_counters_snapshot_dto import NodeCountersSnapshotDTO from .models.node_dto import NodeDTO @@ -146,6 +155,19 @@ from .models.node_status_snapshots_dto import NodeStatusSnapshotsDTO from .models.node_system_diagnostics_snapshot_dto import NodeSystemDiagnosticsSnapshotDTO from .models.output_ports_entity import OutputPortsEntity +from .models.parameter_context_dto import ParameterContextDTO +from .models.parameter_context_entity import ParameterContextEntity +from .models.parameter_context_reference_dto import ParameterContextReferenceDTO +from .models.parameter_context_reference_entity import ParameterContextReferenceEntity +from .models.parameter_context_update_request_dto import ParameterContextUpdateRequestDTO +from .models.parameter_context_update_request_entity import ParameterContextUpdateRequestEntity +from .models.parameter_context_update_step_dto import ParameterContextUpdateStepDTO +from .models.parameter_context_validation_request_dto import ParameterContextValidationRequestDTO +from .models.parameter_context_validation_request_entity import ParameterContextValidationRequestEntity +from .models.parameter_context_validation_step_dto import ParameterContextValidationStepDTO +from .models.parameter_contexts_entity import ParameterContextsEntity +from .models.parameter_dto import ParameterDTO +from .models.parameter_entity import ParameterEntity from .models.peer_dto import PeerDTO from .models.peers_entity import PeersEntity from .models.permissions import Permissions @@ -165,6 +187,7 @@ from .models.process_group_entity import ProcessGroupEntity from .models.process_group_flow_dto import ProcessGroupFlowDTO from .models.process_group_flow_entity import ProcessGroupFlowEntity +from .models.process_group_name_dto import ProcessGroupNameDTO from .models.process_group_status_dto import ProcessGroupStatusDTO from .models.process_group_status_entity import ProcessGroupStatusEntity from .models.process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO @@ -247,7 +270,6 @@ from .models.tenants_entity import TenantsEntity from .models.transaction_result_entity import TransactionResultEntity from .models.update_controller_service_reference_request_entity import UpdateControllerServiceReferenceRequestEntity -from .models.uri_builder import UriBuilder from .models.user_dto import UserDTO from .models.user_entity import UserEntity from .models.user_group_dto import UserGroupDTO @@ -281,6 +303,8 @@ from .models.versioned_flows_entity import VersionedFlowsEntity from .models.versioned_funnel import VersionedFunnel from .models.versioned_label import VersionedLabel +from .models.versioned_parameter import VersionedParameter +from .models.versioned_parameter_context import VersionedParameterContext from .models.versioned_port import VersionedPort from .models.versioned_process_group import VersionedProcessGroup from .models.versioned_processor import VersionedProcessor @@ -301,6 +325,7 @@ from .apis.input_ports_api import InputPortsApi from .apis.labels_api import LabelsApi from .apis.output_ports_api import OutputPortsApi +from .apis.parameter_contexts_api import ParameterContextsApi from .apis.policies_api import PoliciesApi from .apis.process_groups_api import ProcessGroupsApi from .apis.processors_api import ProcessorsApi diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index 38b497fe..4a15100b 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -4,7 +4,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/__init__.py b/nipyapi/nifi/apis/__init__.py index 384223cf..2e58f9b2 100644 --- a/nipyapi/nifi/apis/__init__.py +++ b/nipyapi/nifi/apis/__init__.py @@ -13,6 +13,7 @@ from .input_ports_api import InputPortsApi from .labels_api import LabelsApi from .output_ports_api import OutputPortsApi +from .parameter_contexts_api import ParameterContextsApi from .policies_api import PoliciesApi from .process_groups_api import ProcessGroupsApi from .processors_api import ProcessorsApi diff --git a/nipyapi/nifi/apis/access_api.py b/nipyapi/nifi/apis/access_api.py index 9279066c..5531aa02 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -931,6 +931,104 @@ def knox_request_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def log_out(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.log_out_with_http_info(**kwargs) + else: + (data) = self.log_out_with_http_info(**kwargs) + return data + + def log_out_with_http_info(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method log_out" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['*/*']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/access/logout', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def oidc_callback(self, **kwargs): """ Redirect/callback URI for processing the result of the OpenId Connect login sequence. diff --git a/nipyapi/nifi/apis/connections_api.py b/nipyapi/nifi/apis/connections_api.py index a1c96cac..fb88c5c8 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index 4efd0bfe..fcc49e0a 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_services_api.py b/nipyapi/nifi/apis/controller_services_api.py index d0a3be68..0c87aa3b 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/counters_api.py b/nipyapi/nifi/apis/counters_api.py index 027da569..b1f30c6a 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/data_transfer_api.py b/nipyapi/nifi/apis/data_transfer_api.py index 3f52ece7..851f29f7 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/flow_api.py b/nipyapi/nifi/apis/flow_api.py index b1d902b8..d7868da5 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -1084,6 +1084,120 @@ def get_component_history_with_http_info(self, component_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_connection_statistics(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The connection id. (required) + :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false + :param str cluster_node_id: The id of the node where to get the statistics. + :return: ConnectionStatisticsEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connection_statistics_with_http_info(id, **kwargs) + else: + (data) = self.get_connection_statistics_with_http_info(id, **kwargs) + return data + + def get_connection_statistics_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The connection id. (required) + :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false + :param str cluster_node_id: The id of the node where to get the statistics. + :return: ConnectionStatisticsEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'nodewise', 'cluster_node_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connection_statistics" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_connection_statistics`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'nodewise' in params: + query_params.append(('nodewise', params['nodewise'])) + if 'cluster_node_id' in params: + query_params.append(('clusterNodeId', params['cluster_node_id'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/flow/connections/{id}/statistics', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConnectionStatisticsEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_connection_status(self, id, **kwargs): """ Gets status for a connection @@ -2384,6 +2498,104 @@ def get_output_port_status_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_parameter_contexts(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: ParameterContextsEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_parameter_contexts_with_http_info(**kwargs) + else: + (data) = self.get_parameter_contexts_with_http_info(**kwargs) + return data + + def get_parameter_contexts_with_http_info(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: ParameterContextsEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_parameter_contexts" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/flow/parameter-contexts', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextsEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_prioritizers(self, **kwargs): """ Retrieves the types of prioritizers that this NiFi supports diff --git a/nipyapi/nifi/apis/flowfile_queues_api.py b/nipyapi/nifi/apis/flowfile_queues_api.py index 5ce4857b..824cf6ea 100644 --- a/nipyapi/nifi/apis/flowfile_queues_api.py +++ b/nipyapi/nifi/apis/flowfile_queues_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/funnel_api.py b/nipyapi/nifi/apis/funnel_api.py index 4e59788f..24d375c5 100644 --- a/nipyapi/nifi/apis/funnel_api.py +++ b/nipyapi/nifi/apis/funnel_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/input_ports_api.py b/nipyapi/nifi/apis/input_ports_api.py index 1f75b6e2..c174c532 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/labels_api.py b/nipyapi/nifi/apis/labels_api.py index 9a80ebf1..87d40b9e 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/output_ports_api.py b/nipyapi/nifi/apis/output_ports_api.py index d6abf134..cd43a78e 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/parameter_contexts_api.py b/nipyapi/nifi/apis/parameter_contexts_api.py new file mode 100644 index 00000000..c59ff626 --- /dev/null +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -0,0 +1,1170 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class ParameterContextsApi(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 + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def create_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param ParameterContextEntity body: The Parameter Context. (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_parameter_context_with_http_info(body, **kwargs) + else: + (data) = self.create_parameter_context_with_http_info(body, **kwargs) + return data + + def create_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param ParameterContextEntity body: The Parameter Context. (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `create_parameter_context`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The Parameter Context ID. (required) + :param str version: The version is used to verify the client is working with the latest version of the flow. + :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_parameter_context_with_http_info(id, **kwargs) + else: + (data) = self.delete_parameter_context_with_http_info(id, **kwargs) + return data + + def delete_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The Parameter Context ID. (required) + :param str version: The version is used to verify the client is working with the latest version of the flow. + :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `delete_parameter_context`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'version' in params: + query_params.append(('version', params['version'])) + if 'client_id' in params: + query_params.append(('clientId', params['client_id'])) + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_update_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the ParameterContext (required) + :param str request_id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_update_request_with_http_info(context_id, request_id, **kwargs) + else: + (data) = self.delete_update_request_with_http_info(context_id, request_id, **kwargs) + return data + + def delete_update_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the ParameterContext (required) + :param str request_id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'request_id', 'disconnected_node_acknowledged'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_update_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `delete_update_request`") + # verify the required parameter 'request_id' is set + if ('request_id' not in params) or (params['request_id'] is None): + raise ValueError("Missing the required parameter `request_id` when calling `delete_update_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'request_id' in params: + path_params['requestId'] = params['request_id'] + + query_params = [] + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextUpdateRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_validation_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_validation_request_with_http_info(context_id, id, **kwargs) + else: + (data) = self.delete_validation_request_with_http_info(context_id, id, **kwargs) + return data + + def delete_validation_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'id', 'disconnected_node_acknowledged'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_validation_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `delete_validation_request`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `delete_validation_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextValidationRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_parameter_context_with_http_info(id, **kwargs) + else: + (data) = self.get_parameter_context_with_http_info(id, **kwargs) + return data + + def get_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_parameter_context`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_parameter_context_update(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str request_id: The ID of the Update Request (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_parameter_context_update_with_http_info(context_id, request_id, **kwargs) + else: + (data) = self.get_parameter_context_update_with_http_info(context_id, request_id, **kwargs) + return data + + def get_parameter_context_update_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str request_id: The ID of the Update Request (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'request_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_parameter_context_update" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `get_parameter_context_update`") + # verify the required parameter 'request_id' is set + if ('request_id' not in params) or (params['request_id'] is None): + raise ValueError("Missing the required parameter `request_id` when calling `get_parameter_context_update`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'request_id' in params: + path_params['requestId'] = params['request_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextUpdateRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_validation_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Validation Request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_validation_request_with_http_info(context_id, id, **kwargs) + else: + (data) = self.get_validation_request_with_http_info(context_id, id, **kwargs) + return data + + def get_validation_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Validation Request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_validation_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `get_validation_request`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_validation_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextValidationRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def submit_parameter_context_update(self, 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 acttion 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextEntity body: The updated version of the parameter context. (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.submit_parameter_context_update_with_http_info(context_id, body, **kwargs) + else: + (data) = self.submit_parameter_context_update_with_http_info(context_id, body, **kwargs) + return data + + def submit_parameter_context_update_with_http_info(self, 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 acttion 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextEntity body: The updated version of the parameter context. (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method submit_parameter_context_update" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `submit_parameter_context_update`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `submit_parameter_context_update`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextUpdateRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def submit_validation_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextValidationRequestEntity body: The validation request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.submit_validation_request_with_http_info(context_id, body, **kwargs) + else: + (data) = self.submit_validation_request_with_http_info(context_id, body, **kwargs) + return data + + def submit_validation_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextValidationRequestEntity body: The validation request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method submit_validation_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `submit_validation_request`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `submit_validation_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextValidationRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: (required) + :param ParameterContextEntity body: The updated Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_parameter_context_with_http_info(id, body, **kwargs) + else: + (data) = self.update_parameter_context_with_http_info(id, body, **kwargs) + return data + + def update_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: (required) + :param ParameterContextEntity body: The updated Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_parameter_context`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `update_parameter_context`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{id}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/nipyapi/nifi/apis/policies_api.py b/nipyapi/nifi/apis/policies_api.py index 60843907..46e1c38e 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/process_groups_api.py b/nipyapi/nifi/apis/process_groups_api.py index a3edce41..31f6da0a 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/processors_api.py b/nipyapi/nifi/apis/processors_api.py index abb0b20c..3d447c01 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index 5aac4b96..8f81920b 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_events_api.py b/nipyapi/nifi/apis/provenance_events_api.py index f78f1770..7e1a1dc0 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/remote_process_groups_api.py b/nipyapi/nifi/apis/remote_process_groups_api.py index 1698e979..51efe7d6 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -146,6 +146,112 @@ def get_remote_process_group_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_state(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The processor id. (required) + :return: ComponentStateEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_state_with_http_info(id, **kwargs) + else: + (data) = self.get_state_with_http_info(id, **kwargs) + return data + + def get_state_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The processor id. (required) + :return: ComponentStateEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_state" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_state`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/remote-process-groups/{id}/state', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ComponentStateEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def remove_remote_process_group(self, id, **kwargs): """ Deletes a remote process group diff --git a/nipyapi/nifi/apis/reporting_tasks_api.py b/nipyapi/nifi/apis/reporting_tasks_api.py index 09b064aa..ac5391f7 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/resources_api.py b/nipyapi/nifi/apis/resources_api.py index b504f7cf..e6cb107a 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/site_to_site_api.py b/nipyapi/nifi/apis/site_to_site_api.py index 5022fbb8..003b560d 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/snippets_api.py b/nipyapi/nifi/apis/snippets_api.py index f863245a..f2a71809 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/system_diagnostics_api.py b/nipyapi/nifi/apis/system_diagnostics_api.py index e826a921..fae94739 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/templates_api.py b/nipyapi/nifi/apis/templates_api.py index 6f53a54f..8882986f 100644 --- a/nipyapi/nifi/apis/templates_api.py +++ b/nipyapi/nifi/apis/templates_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/tenants_api.py b/nipyapi/nifi/apis/tenants_api.py index 4f727f24..0eaecf1a 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/versions_api.py b/nipyapi/nifi/apis/versions_api.py index ed455e7e..b9f4bb09 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 3969e5cb..432f5720 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -228,6 +228,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.9.1\n"\ + "Version of the API: 1.10.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/nifi/models/__init__.py b/nipyapi/nifi/models/__init__.py index 43cafc5c..bc65572d 100644 --- a/nipyapi/nifi/models/__init__.py +++ b/nipyapi/nifi/models/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,12 +62,19 @@ from .component_search_result_dto import ComponentSearchResultDTO from .component_state_dto import ComponentStateDTO from .component_state_entity import ComponentStateEntity +from .component_validation_result_dto import ComponentValidationResultDTO +from .component_validation_result_entity import ComponentValidationResultEntity +from .component_validation_results_entity import ComponentValidationResultsEntity from .connectable_component import ConnectableComponent from .connectable_dto import ConnectableDTO from .connection_dto import ConnectionDTO from .connection_entity import ConnectionEntity +from .connection_statistics_dto import ConnectionStatisticsDTO +from .connection_statistics_entity import ConnectionStatisticsEntity +from .connection_statistics_snapshot_dto import ConnectionStatisticsSnapshotDTO from .connection_status_dto import ConnectionStatusDTO from .connection_status_entity import ConnectionStatusEntity +from .connection_status_predictions_snapshot_dto import ConnectionStatusPredictionsSnapshotDTO from .connection_status_snapshot_dto import ConnectionStatusSnapshotDTO from .connection_status_snapshot_entity import ConnectionStatusSnapshotEntity from .connections_entity import ConnectionsEntity @@ -104,6 +111,7 @@ from .drop_request_dto import DropRequestDTO from .drop_request_entity import DropRequestEntity from .explicit_restriction_dto import ExplicitRestrictionDTO +from .external_controller_service_reference import ExternalControllerServiceReference from .flow_breadcrumb_dto import FlowBreadcrumbDTO from .flow_breadcrumb_entity import FlowBreadcrumbEntity from .flow_comparison_entity import FlowComparisonEntity @@ -123,6 +131,7 @@ from .history_entity import HistoryEntity from .input_ports_entity import InputPortsEntity from .instantiate_template_request_entity import InstantiateTemplateRequestEntity +from .jaxb_link import JaxbLink from .label_dto import LabelDTO from .label_entity import LabelEntity from .labels_entity import LabelsEntity @@ -130,9 +139,9 @@ from .lineage_entity import LineageEntity from .lineage_request_dto import LineageRequestDTO from .lineage_results_dto import LineageResultsDTO -from .link import Link from .listing_request_dto import ListingRequestDTO from .listing_request_entity import ListingRequestEntity +from .node_connection_statistics_snapshot_dto import NodeConnectionStatisticsSnapshotDTO from .node_connection_status_snapshot_dto import NodeConnectionStatusSnapshotDTO from .node_counters_snapshot_dto import NodeCountersSnapshotDTO from .node_dto import NodeDTO @@ -146,6 +155,19 @@ from .node_status_snapshots_dto import NodeStatusSnapshotsDTO from .node_system_diagnostics_snapshot_dto import NodeSystemDiagnosticsSnapshotDTO from .output_ports_entity import OutputPortsEntity +from .parameter_context_dto import ParameterContextDTO +from .parameter_context_entity import ParameterContextEntity +from .parameter_context_reference_dto import ParameterContextReferenceDTO +from .parameter_context_reference_entity import ParameterContextReferenceEntity +from .parameter_context_update_request_dto import ParameterContextUpdateRequestDTO +from .parameter_context_update_request_entity import ParameterContextUpdateRequestEntity +from .parameter_context_update_step_dto import ParameterContextUpdateStepDTO +from .parameter_context_validation_request_dto import ParameterContextValidationRequestDTO +from .parameter_context_validation_request_entity import ParameterContextValidationRequestEntity +from .parameter_context_validation_step_dto import ParameterContextValidationStepDTO +from .parameter_contexts_entity import ParameterContextsEntity +from .parameter_dto import ParameterDTO +from .parameter_entity import ParameterEntity from .peer_dto import PeerDTO from .peers_entity import PeersEntity from .permissions import Permissions @@ -165,6 +187,7 @@ from .process_group_entity import ProcessGroupEntity from .process_group_flow_dto import ProcessGroupFlowDTO from .process_group_flow_entity import ProcessGroupFlowEntity +from .process_group_name_dto import ProcessGroupNameDTO from .process_group_status_dto import ProcessGroupStatusDTO from .process_group_status_entity import ProcessGroupStatusEntity from .process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO @@ -247,7 +270,6 @@ from .tenants_entity import TenantsEntity from .transaction_result_entity import TransactionResultEntity from .update_controller_service_reference_request_entity import UpdateControllerServiceReferenceRequestEntity -from .uri_builder import UriBuilder from .user_dto import UserDTO from .user_entity import UserEntity from .user_group_dto import UserGroupDTO @@ -281,6 +303,8 @@ from .versioned_flows_entity import VersionedFlowsEntity from .versioned_funnel import VersionedFunnel from .versioned_label import VersionedLabel +from .versioned_parameter import VersionedParameter +from .versioned_parameter_context import VersionedParameterContext from .versioned_port import VersionedPort from .versioned_process_group import VersionedProcessGroup from .versioned_processor import VersionedProcessor diff --git a/nipyapi/nifi/models/about_dto.py b/nipyapi/nifi/models/about_dto.py index 188ebbc0..7ca899b4 100644 --- a/nipyapi/nifi/models/about_dto.py +++ b/nipyapi/nifi/models/about_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/about_entity.py b/nipyapi/nifi/models/about_entity.py index 7e346eef..3b4171ae 100644 --- a/nipyapi/nifi/models/about_entity.py +++ b/nipyapi/nifi/models/about_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_dto.py b/nipyapi/nifi/models/access_configuration_dto.py index 27e55e56..2eb434da 100644 --- a/nipyapi/nifi/models/access_configuration_dto.py +++ b/nipyapi/nifi/models/access_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_entity.py b/nipyapi/nifi/models/access_configuration_entity.py index db1350ae..408e6a7d 100644 --- a/nipyapi/nifi/models/access_configuration_entity.py +++ b/nipyapi/nifi/models/access_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_dto.py b/nipyapi/nifi/models/access_policy_dto.py index ad0aea3a..5ed63c33 100644 --- a/nipyapi/nifi/models/access_policy_dto.py +++ b/nipyapi/nifi/models/access_policy_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_entity.py b/nipyapi/nifi/models/access_policy_entity.py index db3f1821..fb977d6d 100644 --- a/nipyapi/nifi/models/access_policy_entity.py +++ b/nipyapi/nifi/models/access_policy_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_dto.py b/nipyapi/nifi/models/access_policy_summary_dto.py index cb87b35c..1941664d 100644 --- a/nipyapi/nifi/models/access_policy_summary_dto.py +++ b/nipyapi/nifi/models/access_policy_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_entity.py b/nipyapi/nifi/models/access_policy_summary_entity.py index 593e8043..0570b7d8 100644 --- a/nipyapi/nifi/models/access_policy_summary_entity.py +++ b/nipyapi/nifi/models/access_policy_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_dto.py b/nipyapi/nifi/models/access_status_dto.py index 1733d1d9..155f03c1 100644 --- a/nipyapi/nifi/models/access_status_dto.py +++ b/nipyapi/nifi/models/access_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_entity.py b/nipyapi/nifi/models/access_status_entity.py index 979182ce..bb4297f8 100644 --- a/nipyapi/nifi/models/access_status_entity.py +++ b/nipyapi/nifi/models/access_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_details_dto.py b/nipyapi/nifi/models/action_details_dto.py index 90db49a7..7b91d8a0 100644 --- a/nipyapi/nifi/models/action_details_dto.py +++ b/nipyapi/nifi/models/action_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_dto.py b/nipyapi/nifi/models/action_dto.py index 6a4c52a6..9ac2f541 100644 --- a/nipyapi/nifi/models/action_dto.py +++ b/nipyapi/nifi/models/action_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_entity.py b/nipyapi/nifi/models/action_entity.py index 9c40e849..7c59c5a4 100644 --- a/nipyapi/nifi/models/action_entity.py +++ b/nipyapi/nifi/models/action_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/activate_controller_services_entity.py b/nipyapi/nifi/models/activate_controller_services_entity.py index 61063966..c7787fef 100644 --- a/nipyapi/nifi/models/activate_controller_services_entity.py +++ b/nipyapi/nifi/models/activate_controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_dto.py b/nipyapi/nifi/models/affected_component_dto.py index ca3d6ba8..44f3bdcc 100644 --- a/nipyapi/nifi/models/affected_component_dto.py +++ b/nipyapi/nifi/models/affected_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_entity.py b/nipyapi/nifi/models/affected_component_entity.py index 72dfa38d..42aeb358 100644 --- a/nipyapi/nifi/models/affected_component_entity.py +++ b/nipyapi/nifi/models/affected_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,9 @@ class AffectedComponentEntity(object): 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', 'disconnected_node_acknowledged': 'bool', - 'component': 'AffectedComponentDTO' + 'component': 'AffectedComponentDTO', + 'process_group': 'ProcessGroupNameDTO', + 'reference_type': 'str' } attribute_map = { @@ -49,10 +51,12 @@ class AffectedComponentEntity(object): 'permissions': 'permissions', 'bulletins': 'bulletins', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' + 'component': 'component', + 'process_group': 'processGroup', + 'reference_type': 'referenceType' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, process_group=None, reference_type=None): """ AffectedComponentEntity - a model defined in Swagger """ @@ -65,6 +69,8 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self._bulletins = None self._disconnected_node_acknowledged = None self._component = None + self._process_group = None + self._reference_type = None if revision is not None: self.revision = revision @@ -82,6 +88,10 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if process_group is not None: + self.process_group = process_group + if reference_type is not None: + self.reference_type = reference_type @property def revision(self): @@ -265,6 +275,58 @@ def component(self, component): self._component = component + @property + def process_group(self): + """ + Gets the process_group of this AffectedComponentEntity. + The Process Group that the component belongs to + + :return: The process_group of this AffectedComponentEntity. + :rtype: ProcessGroupNameDTO + """ + return self._process_group + + @process_group.setter + def process_group(self, process_group): + """ + Sets the process_group of this AffectedComponentEntity. + The Process Group that the component belongs to + + :param process_group: The process_group of this AffectedComponentEntity. + :type: ProcessGroupNameDTO + """ + + self._process_group = process_group + + @property + def reference_type(self): + """ + Gets the reference_type of this AffectedComponentEntity. + The type of component referenced + + :return: The reference_type of this AffectedComponentEntity. + :rtype: str + """ + return self._reference_type + + @reference_type.setter + def reference_type(self, reference_type): + """ + Sets the reference_type of this AffectedComponentEntity. + The type of component referenced + + :param reference_type: The reference_type of this AffectedComponentEntity. + :type: str + """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT"] + if reference_type not in allowed_values: + raise ValueError( + "Invalid value for `reference_type` ({0}), must be one of {1}" + .format(reference_type, allowed_values) + ) + + self._reference_type = reference_type + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/allowable_value_dto.py b/nipyapi/nifi/models/allowable_value_dto.py index 8e61a38d..a79cc4d2 100644 --- a/nipyapi/nifi/models/allowable_value_dto.py +++ b/nipyapi/nifi/models/allowable_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_entity.py b/nipyapi/nifi/models/allowable_value_entity.py index 17f0b700..137c28a6 100644 --- a/nipyapi/nifi/models/allowable_value_entity.py +++ b/nipyapi/nifi/models/allowable_value_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/attribute_dto.py b/nipyapi/nifi/models/attribute_dto.py index 467ad9ce..7153864b 100644 --- a/nipyapi/nifi/models/attribute_dto.py +++ b/nipyapi/nifi/models/attribute_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_dto.py b/nipyapi/nifi/models/banner_dto.py index 491859a5..b90bc3e5 100644 --- a/nipyapi/nifi/models/banner_dto.py +++ b/nipyapi/nifi/models/banner_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_entity.py b/nipyapi/nifi/models/banner_entity.py index 64f91979..b4e829c8 100644 --- a/nipyapi/nifi/models/banner_entity.py +++ b/nipyapi/nifi/models/banner_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_settings_dto.py b/nipyapi/nifi/models/batch_settings_dto.py index b3a13fcf..3ce67048 100644 --- a/nipyapi/nifi/models/batch_settings_dto.py +++ b/nipyapi/nifi/models/batch_settings_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_size.py b/nipyapi/nifi/models/batch_size.py index 1b8b01f2..c65afad6 100644 --- a/nipyapi/nifi/models/batch_size.py +++ b/nipyapi/nifi/models/batch_size.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket.py b/nipyapi/nifi/models/bucket.py index e7eadeb9..f069677d 100644 --- a/nipyapi/nifi/models/bucket.py +++ b/nipyapi/nifi/models/bucket.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,11 +31,13 @@ class Bucket(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'identifier': 'str', 'name': 'str', 'created_timestamp': 'int', 'description': 'str', + 'allow_bundle_redeploy': 'bool', + 'allow_public_read': 'bool', 'permissions': 'Permissions' } @@ -45,10 +47,12 @@ class Bucket(object): 'name': 'name', 'created_timestamp': 'createdTimestamp', 'description': 'description', + 'allow_bundle_redeploy': 'allowBundleRedeploy', + 'allow_public_read': 'allowPublicRead', 'permissions': 'permissions' } - def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, permissions=None): + def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None): """ Bucket - a model defined in Swagger """ @@ -58,6 +62,8 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self._name = None self._created_timestamp = None self._description = None + self._allow_bundle_redeploy = None + self._allow_public_read = None self._permissions = None if link is not None: @@ -69,6 +75,10 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self.created_timestamp = created_timestamp if description is not None: self.description = description + if allow_bundle_redeploy is not None: + self.allow_bundle_redeploy = allow_bundle_redeploy + if allow_public_read is not None: + self.allow_public_read = allow_public_read if permissions is not None: self.permissions = permissions @@ -79,7 +89,7 @@ def link(self): An WebLink to this entity. :return: The link of this Bucket. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -90,7 +100,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this Bucket. - :type: Link + :type: JaxbLink """ self._link = link @@ -191,6 +201,52 @@ def description(self, description): self._description = description + @property + def allow_bundle_redeploy(self): + """ + 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. + + :return: The allow_bundle_redeploy of this Bucket. + :rtype: bool + """ + return self._allow_bundle_redeploy + + @allow_bundle_redeploy.setter + def allow_bundle_redeploy(self, allow_bundle_redeploy): + """ + Sets 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. + + :param allow_bundle_redeploy: The allow_bundle_redeploy of this Bucket. + :type: bool + """ + + self._allow_bundle_redeploy = allow_bundle_redeploy + + @property + def allow_public_read(self): + """ + Gets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users + + :return: The allow_public_read of this Bucket. + :rtype: bool + """ + return self._allow_public_read + + @allow_public_read.setter + def allow_public_read(self, allow_public_read): + """ + Sets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users + + :param allow_public_read: The allow_public_read of this Bucket. + :type: bool + """ + + self._allow_public_read = allow_public_read + @property def permissions(self): """ diff --git a/nipyapi/nifi/models/bucket_dto.py b/nipyapi/nifi/models/bucket_dto.py index d22673ce..a5c266ea 100644 --- a/nipyapi/nifi/models/bucket_dto.py +++ b/nipyapi/nifi/models/bucket_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket_entity.py b/nipyapi/nifi/models/bucket_entity.py index e88c3aaf..05a97281 100644 --- a/nipyapi/nifi/models/bucket_entity.py +++ b/nipyapi/nifi/models/bucket_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/buckets_entity.py b/nipyapi/nifi/models/buckets_entity.py index a11bb36b..a85ca054 100644 --- a/nipyapi/nifi/models/buckets_entity.py +++ b/nipyapi/nifi/models/buckets_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_dto.py b/nipyapi/nifi/models/bulletin_board_dto.py index 45c19f43..c82ad8f7 100644 --- a/nipyapi/nifi/models/bulletin_board_dto.py +++ b/nipyapi/nifi/models/bulletin_board_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_entity.py b/nipyapi/nifi/models/bulletin_board_entity.py index 3a9033ad..8b0437b8 100644 --- a/nipyapi/nifi/models/bulletin_board_entity.py +++ b/nipyapi/nifi/models/bulletin_board_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_dto.py b/nipyapi/nifi/models/bulletin_dto.py index 6dc2834e..81ae073a 100644 --- a/nipyapi/nifi/models/bulletin_dto.py +++ b/nipyapi/nifi/models/bulletin_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_entity.py b/nipyapi/nifi/models/bulletin_entity.py index 8027e6e8..c7dfacac 100644 --- a/nipyapi/nifi/models/bulletin_entity.py +++ b/nipyapi/nifi/models/bulletin_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle.py b/nipyapi/nifi/models/bundle.py index 85f5daac..23cdc89d 100644 --- a/nipyapi/nifi/models/bundle.py +++ b/nipyapi/nifi/models/bundle.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle_dto.py b/nipyapi/nifi/models/bundle_dto.py index 50462bb5..dc3d7745 100644 --- a/nipyapi/nifi/models/bundle_dto.py +++ b/nipyapi/nifi/models/bundle_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluste_summary_entity.py b/nipyapi/nifi/models/cluste_summary_entity.py index 3b1453f6..8143865a 100644 --- a/nipyapi/nifi/models/cluste_summary_entity.py +++ b/nipyapi/nifi/models/cluste_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_dto.py b/nipyapi/nifi/models/cluster_dto.py index 381c38de..9f46554c 100644 --- a/nipyapi/nifi/models/cluster_dto.py +++ b/nipyapi/nifi/models/cluster_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_entity.py b/nipyapi/nifi/models/cluster_entity.py index 889438ae..8d28abdd 100644 --- a/nipyapi/nifi/models/cluster_entity.py +++ b/nipyapi/nifi/models/cluster_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_search_results_entity.py b/nipyapi/nifi/models/cluster_search_results_entity.py index abf55d60..55088a1e 100644 --- a/nipyapi/nifi/models/cluster_search_results_entity.py +++ b/nipyapi/nifi/models/cluster_search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_summary_dto.py b/nipyapi/nifi/models/cluster_summary_dto.py index 0a345803..24e30bf1 100644 --- a/nipyapi/nifi/models/cluster_summary_dto.py +++ b/nipyapi/nifi/models/cluster_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_details_dto.py b/nipyapi/nifi/models/component_details_dto.py index 1712f82b..fb4730a7 100644 --- a/nipyapi/nifi/models/component_details_dto.py +++ b/nipyapi/nifi/models/component_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_difference_dto.py b/nipyapi/nifi/models/component_difference_dto.py index 0e962fb1..cb8dad5d 100644 --- a/nipyapi/nifi/models/component_difference_dto.py +++ b/nipyapi/nifi/models/component_difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_dto.py b/nipyapi/nifi/models/component_history_dto.py index 65a968ee..2b7cc956 100644 --- a/nipyapi/nifi/models/component_history_dto.py +++ b/nipyapi/nifi/models/component_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_entity.py b/nipyapi/nifi/models/component_history_entity.py index 68e975bc..75945e31 100644 --- a/nipyapi/nifi/models/component_history_entity.py +++ b/nipyapi/nifi/models/component_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_dto.py b/nipyapi/nifi/models/component_reference_dto.py index 9ee08e27..1015c76c 100644 --- a/nipyapi/nifi/models/component_reference_dto.py +++ b/nipyapi/nifi/models/component_reference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_entity.py b/nipyapi/nifi/models/component_reference_entity.py index 7a9ea8d3..020b7533 100644 --- a/nipyapi/nifi/models/component_reference_entity.py +++ b/nipyapi/nifi/models/component_reference_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_restriction_permission_dto.py b/nipyapi/nifi/models/component_restriction_permission_dto.py index 1cd1c37d..a27a5f87 100644 --- a/nipyapi/nifi/models/component_restriction_permission_dto.py +++ b/nipyapi/nifi/models/component_restriction_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_search_result_dto.py b/nipyapi/nifi/models/component_search_result_dto.py index d0968302..680af7cf 100644 --- a/nipyapi/nifi/models/component_search_result_dto.py +++ b/nipyapi/nifi/models/component_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_dto.py b/nipyapi/nifi/models/component_state_dto.py index 84444f4d..cd52e813 100644 --- a/nipyapi/nifi/models/component_state_dto.py +++ b/nipyapi/nifi/models/component_state_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_entity.py b/nipyapi/nifi/models/component_state_entity.py index f0ee8130..b77c7b09 100644 --- a/nipyapi/nifi/models/component_state_entity.py +++ b/nipyapi/nifi/models/component_state_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_dto.py b/nipyapi/nifi/models/component_validation_result_dto.py new file mode 100644 index 00000000..fff661f5 --- /dev/null +++ b/nipyapi/nifi/models/component_validation_result_dto.py @@ -0,0 +1,383 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ComponentValidationResultDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'process_group_id': 'str', + 'id': 'str', + 'reference_type': 'str', + 'name': 'str', + 'state': 'str', + 'active_thread_count': 'int', + 'validation_errors': 'list[str]', + 'currently_valid': 'bool', + 'results_valid': 'bool', + 'resultant_validation_errors': 'list[str]' + } + + attribute_map = { + 'process_group_id': 'processGroupId', + 'id': 'id', + 'reference_type': 'referenceType', + 'name': 'name', + 'state': 'state', + 'active_thread_count': 'activeThreadCount', + 'validation_errors': 'validationErrors', + 'currently_valid': 'currentlyValid', + 'results_valid': 'resultsValid', + 'resultant_validation_errors': 'resultantValidationErrors' + } + + def __init__(self, process_group_id=None, id=None, reference_type=None, name=None, state=None, active_thread_count=None, validation_errors=None, currently_valid=None, results_valid=None, resultant_validation_errors=None): + """ + ComponentValidationResultDTO - a model defined in Swagger + """ + + self._process_group_id = None + self._id = None + self._reference_type = None + self._name = None + self._state = None + self._active_thread_count = None + self._validation_errors = None + self._currently_valid = None + self._results_valid = None + self._resultant_validation_errors = None + + if process_group_id is not None: + self.process_group_id = process_group_id + if id is not None: + self.id = id + if reference_type is not None: + self.reference_type = reference_type + if name is not None: + self.name = name + if state is not None: + self.state = state + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if validation_errors is not None: + self.validation_errors = validation_errors + if currently_valid is not None: + self.currently_valid = currently_valid + if results_valid is not None: + self.results_valid = results_valid + if resultant_validation_errors is not None: + self.resultant_validation_errors = resultant_validation_errors + + @property + def process_group_id(self): + """ + Gets the process_group_id of this ComponentValidationResultDTO. + The UUID of the Process Group that this component is in + + :return: The process_group_id of this ComponentValidationResultDTO. + :rtype: str + """ + return self._process_group_id + + @process_group_id.setter + def process_group_id(self, process_group_id): + """ + Sets the process_group_id of this ComponentValidationResultDTO. + The UUID of the Process Group that this component is in + + :param process_group_id: The process_group_id of this ComponentValidationResultDTO. + :type: str + """ + + self._process_group_id = process_group_id + + @property + def id(self): + """ + Gets the id of this ComponentValidationResultDTO. + The UUID of this component + + :return: The id of this ComponentValidationResultDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ComponentValidationResultDTO. + The UUID of this component + + :param id: The id of this ComponentValidationResultDTO. + :type: str + """ + + self._id = id + + @property + def reference_type(self): + """ + Gets the reference_type of this ComponentValidationResultDTO. + The type of this component + + :return: The reference_type of this ComponentValidationResultDTO. + :rtype: str + """ + return self._reference_type + + @reference_type.setter + def reference_type(self, reference_type): + """ + Sets the reference_type of this ComponentValidationResultDTO. + The type of this component + + :param reference_type: The reference_type of this ComponentValidationResultDTO. + :type: str + """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT"] + if reference_type not in allowed_values: + raise ValueError( + "Invalid value for `reference_type` ({0}), must be one of {1}" + .format(reference_type, allowed_values) + ) + + self._reference_type = reference_type + + @property + def name(self): + """ + Gets the name of this ComponentValidationResultDTO. + The name of this component. + + :return: The name of this ComponentValidationResultDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ComponentValidationResultDTO. + The name of this component. + + :param name: The name of this ComponentValidationResultDTO. + :type: str + """ + + self._name = name + + @property + def state(self): + """ + Gets the state of this ComponentValidationResultDTO. + 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. + + :return: The state of this ComponentValidationResultDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ComponentValidationResultDTO. + 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. + + :param state: The state of this ComponentValidationResultDTO. + :type: str + """ + + self._state = state + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this ComponentValidationResultDTO. + The number of active threads for the referencing component. + + :return: The active_thread_count of this ComponentValidationResultDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ComponentValidationResultDTO. + The number of active threads for the referencing component. + + :param active_thread_count: The active_thread_count of this ComponentValidationResultDTO. + :type: int + """ + + self._active_thread_count = active_thread_count + + @property + def validation_errors(self): + """ + Gets the validation_errors of this ComponentValidationResultDTO. + The validation errors for the component. + + :return: The validation_errors of this ComponentValidationResultDTO. + :rtype: list[str] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """ + Sets the validation_errors of this ComponentValidationResultDTO. + The validation errors for the component. + + :param validation_errors: The validation_errors of this ComponentValidationResultDTO. + :type: list[str] + """ + + self._validation_errors = validation_errors + + @property + def currently_valid(self): + """ + Gets the currently_valid of this ComponentValidationResultDTO. + Whether or not the component is currently valid + + :return: The currently_valid of this ComponentValidationResultDTO. + :rtype: bool + """ + return self._currently_valid + + @currently_valid.setter + def currently_valid(self, currently_valid): + """ + Sets the currently_valid of this ComponentValidationResultDTO. + Whether or not the component is currently valid + + :param currently_valid: The currently_valid of this ComponentValidationResultDTO. + :type: bool + """ + + self._currently_valid = currently_valid + + @property + def results_valid(self): + """ + Gets the results_valid of this ComponentValidationResultDTO. + Whether or not the component will be valid if the Parameter Context is changed + + :return: The results_valid of this ComponentValidationResultDTO. + :rtype: bool + """ + return self._results_valid + + @results_valid.setter + def results_valid(self, results_valid): + """ + Sets the results_valid of this ComponentValidationResultDTO. + Whether or not the component will be valid if the Parameter Context is changed + + :param results_valid: The results_valid of this ComponentValidationResultDTO. + :type: bool + """ + + self._results_valid = results_valid + + @property + def resultant_validation_errors(self): + """ + Gets the resultant_validation_errors of this ComponentValidationResultDTO. + The validation errors that will apply to the component if the Parameter Context is changed + + :return: The resultant_validation_errors of this ComponentValidationResultDTO. + :rtype: list[str] + """ + return self._resultant_validation_errors + + @resultant_validation_errors.setter + def resultant_validation_errors(self, resultant_validation_errors): + """ + Sets the resultant_validation_errors of this ComponentValidationResultDTO. + The validation errors that will apply to the component if the Parameter Context is changed + + :param resultant_validation_errors: The resultant_validation_errors of this ComponentValidationResultDTO. + :type: list[str] + """ + + self._resultant_validation_errors = resultant_validation_errors + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ComponentValidationResultDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/component_validation_result_entity.py b/nipyapi/nifi/models/component_validation_result_entity.py new file mode 100644 index 00000000..71630e71 --- /dev/null +++ b/nipyapi/nifi/models/component_validation_result_entity.py @@ -0,0 +1,319 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ComponentValidationResultEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'revision': 'RevisionDTO', + 'id': 'str', + 'uri': 'str', + 'position': 'PositionDTO', + 'permissions': 'PermissionsDTO', + 'bulletins': 'list[BulletinEntity]', + 'disconnected_node_acknowledged': 'bool', + 'component': 'ComponentValidationResultDTO' + } + + attribute_map = { + 'revision': 'revision', + 'id': 'id', + 'uri': 'uri', + 'position': 'position', + 'permissions': 'permissions', + 'bulletins': 'bulletins', + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', + 'component': 'component' + } + + def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + """ + ComponentValidationResultEntity - a model defined in Swagger + """ + + self._revision = None + self._id = None + self._uri = None + self._position = None + self._permissions = None + self._bulletins = None + self._disconnected_node_acknowledged = None + self._component = None + + if revision is not None: + self.revision = revision + if id is not None: + self.id = id + if uri is not None: + self.uri = uri + if position is not None: + self.position = position + if permissions is not None: + self.permissions = permissions + if bulletins is not None: + self.bulletins = bulletins + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if component is not None: + self.component = component + + @property + def revision(self): + """ + Gets the revision of this ComponentValidationResultEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :return: The revision of this ComponentValidationResultEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ComponentValidationResultEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :param revision: The revision of this ComponentValidationResultEntity. + :type: RevisionDTO + """ + + self._revision = revision + + @property + def id(self): + """ + Gets the id of this ComponentValidationResultEntity. + The id of the component. + + :return: The id of this ComponentValidationResultEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ComponentValidationResultEntity. + The id of the component. + + :param id: The id of this ComponentValidationResultEntity. + :type: str + """ + + self._id = id + + @property + def uri(self): + """ + Gets the uri of this ComponentValidationResultEntity. + The URI for futures requests to the component. + + :return: The uri of this ComponentValidationResultEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ComponentValidationResultEntity. + The URI for futures requests to the component. + + :param uri: The uri of this ComponentValidationResultEntity. + :type: str + """ + + self._uri = uri + + @property + def position(self): + """ + Gets the position of this ComponentValidationResultEntity. + The position of this component in the UI if applicable. + + :return: The position of this ComponentValidationResultEntity. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this ComponentValidationResultEntity. + The position of this component in the UI if applicable. + + :param position: The position of this ComponentValidationResultEntity. + :type: PositionDTO + """ + + self._position = position + + @property + def permissions(self): + """ + Gets the permissions of this ComponentValidationResultEntity. + The permissions for this component. + + :return: The permissions of this ComponentValidationResultEntity. + :rtype: PermissionsDTO + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ComponentValidationResultEntity. + The permissions for this component. + + :param permissions: The permissions of this ComponentValidationResultEntity. + :type: PermissionsDTO + """ + + self._permissions = permissions + + @property + def bulletins(self): + """ + Gets the bulletins of this ComponentValidationResultEntity. + The bulletins for this component. + + :return: The bulletins of this ComponentValidationResultEntity. + :rtype: list[BulletinEntity] + """ + return self._bulletins + + @bulletins.setter + def bulletins(self, bulletins): + """ + Sets the bulletins of this ComponentValidationResultEntity. + The bulletins for this component. + + :param bulletins: The bulletins of this ComponentValidationResultEntity. + :type: list[BulletinEntity] + """ + + self._bulletins = bulletins + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ComponentValidationResultEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ComponentValidationResultEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ComponentValidationResultEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ComponentValidationResultEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def component(self): + """ + Gets the component of this ComponentValidationResultEntity. + + :return: The component of this ComponentValidationResultEntity. + :rtype: ComponentValidationResultDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ComponentValidationResultEntity. + + :param component: The component of this ComponentValidationResultEntity. + :type: ComponentValidationResultDTO + """ + + self._component = component + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ComponentValidationResultEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/component_validation_results_entity.py b/nipyapi/nifi/models/component_validation_results_entity.py new file mode 100644 index 00000000..70a64faf --- /dev/null +++ b/nipyapi/nifi/models/component_validation_results_entity.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ComponentValidationResultsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'validation_results': 'list[ComponentValidationResultEntity]' + } + + attribute_map = { + 'validation_results': 'validationResults' + } + + def __init__(self, validation_results=None): + """ + ComponentValidationResultsEntity - a model defined in Swagger + """ + + self._validation_results = None + + if validation_results is not None: + self.validation_results = validation_results + + @property + def validation_results(self): + """ + Gets the validation_results of this ComponentValidationResultsEntity. + A List of ComponentValidationResultEntity, one for each component that is validated + + :return: The validation_results of this ComponentValidationResultsEntity. + :rtype: list[ComponentValidationResultEntity] + """ + return self._validation_results + + @validation_results.setter + def validation_results(self, validation_results): + """ + Sets the validation_results of this ComponentValidationResultsEntity. + A List of ComponentValidationResultEntity, one for each component that is validated + + :param validation_results: The validation_results of this ComponentValidationResultsEntity. + :type: list[ComponentValidationResultEntity] + """ + + self._validation_results = validation_results + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ComponentValidationResultsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connectable_component.py b/nipyapi/nifi/models/connectable_component.py index fe2e1956..ee49dcc6 100644 --- a/nipyapi/nifi/models/connectable_component.py +++ b/nipyapi/nifi/models/connectable_component.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_dto.py b/nipyapi/nifi/models/connectable_dto.py index 115edcde..72cbc9dd 100644 --- a/nipyapi/nifi/models/connectable_dto.py +++ b/nipyapi/nifi/models/connectable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_dto.py b/nipyapi/nifi/models/connection_dto.py index e401e99a..15d5e001 100644 --- a/nipyapi/nifi/models/connection_dto.py +++ b/nipyapi/nifi/models/connection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_entity.py b/nipyapi/nifi/models/connection_entity.py index 6c60cb6c..c48cd824 100644 --- a/nipyapi/nifi/models/connection_entity.py +++ b/nipyapi/nifi/models/connection_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_dto.py b/nipyapi/nifi/models/connection_statistics_dto.py new file mode 100644 index 00000000..2003b318 --- /dev/null +++ b/nipyapi/nifi/models/connection_statistics_dto.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatisticsDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'stats_last_refreshed': 'str', + 'aggregate_snapshot': 'ConnectionStatisticsSnapshotDTO', + 'node_snapshots': 'list[NodeConnectionStatisticsSnapshotDTO]' + } + + attribute_map = { + 'id': 'id', + 'stats_last_refreshed': 'statsLastRefreshed', + 'aggregate_snapshot': 'aggregateSnapshot', + 'node_snapshots': 'nodeSnapshots' + } + + def __init__(self, id=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None): + """ + ConnectionStatisticsDTO - a model defined in Swagger + """ + + self._id = None + self._stats_last_refreshed = None + self._aggregate_snapshot = None + self._node_snapshots = None + + if id is not None: + self.id = id + if stats_last_refreshed is not None: + self.stats_last_refreshed = stats_last_refreshed + if aggregate_snapshot is not None: + self.aggregate_snapshot = aggregate_snapshot + if node_snapshots is not None: + self.node_snapshots = node_snapshots + + @property + def id(self): + """ + Gets the id of this ConnectionStatisticsDTO. + The ID of the connection + + :return: The id of this ConnectionStatisticsDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ConnectionStatisticsDTO. + The ID of the connection + + :param id: The id of this ConnectionStatisticsDTO. + :type: str + """ + + self._id = id + + @property + def stats_last_refreshed(self): + """ + Gets the stats_last_refreshed of this ConnectionStatisticsDTO. + The timestamp of when the stats were last refreshed + + :return: The stats_last_refreshed of this ConnectionStatisticsDTO. + :rtype: str + """ + return self._stats_last_refreshed + + @stats_last_refreshed.setter + def stats_last_refreshed(self, stats_last_refreshed): + """ + Sets the stats_last_refreshed of this ConnectionStatisticsDTO. + The timestamp of when the stats were last refreshed + + :param stats_last_refreshed: The stats_last_refreshed of this ConnectionStatisticsDTO. + :type: str + """ + + self._stats_last_refreshed = stats_last_refreshed + + @property + def aggregate_snapshot(self): + """ + Gets the aggregate_snapshot of this ConnectionStatisticsDTO. + The status snapshot that represents the aggregate stats of the cluster + + :return: The aggregate_snapshot of this ConnectionStatisticsDTO. + :rtype: ConnectionStatisticsSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this ConnectionStatisticsDTO. + The status snapshot that represents the aggregate stats of the cluster + + :param aggregate_snapshot: The aggregate_snapshot of this ConnectionStatisticsDTO. + :type: ConnectionStatisticsSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot + + @property + def node_snapshots(self): + """ + Gets the node_snapshots of this ConnectionStatisticsDTO. + A list of status snapshots for each node + + :return: The node_snapshots of this ConnectionStatisticsDTO. + :rtype: list[NodeConnectionStatisticsSnapshotDTO] + """ + return self._node_snapshots + + @node_snapshots.setter + def node_snapshots(self, node_snapshots): + """ + Sets the node_snapshots of this ConnectionStatisticsDTO. + A list of status snapshots for each node + + :param node_snapshots: The node_snapshots of this ConnectionStatisticsDTO. + :type: list[NodeConnectionStatisticsSnapshotDTO] + """ + + self._node_snapshots = node_snapshots + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatisticsDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_statistics_entity.py b/nipyapi/nifi/models/connection_statistics_entity.py new file mode 100644 index 00000000..cd6a18d5 --- /dev/null +++ b/nipyapi/nifi/models/connection_statistics_entity.py @@ -0,0 +1,151 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatisticsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'connection_statistics': 'ConnectionStatisticsDTO', + 'can_read': 'bool' + } + + attribute_map = { + 'connection_statistics': 'connectionStatistics', + 'can_read': 'canRead' + } + + def __init__(self, connection_statistics=None, can_read=None): + """ + ConnectionStatisticsEntity - a model defined in Swagger + """ + + self._connection_statistics = None + self._can_read = None + + if connection_statistics is not None: + self.connection_statistics = connection_statistics + if can_read is not None: + self.can_read = can_read + + @property + def connection_statistics(self): + """ + Gets the connection_statistics of this ConnectionStatisticsEntity. + + :return: The connection_statistics of this ConnectionStatisticsEntity. + :rtype: ConnectionStatisticsDTO + """ + return self._connection_statistics + + @connection_statistics.setter + def connection_statistics(self, connection_statistics): + """ + Sets the connection_statistics of this ConnectionStatisticsEntity. + + :param connection_statistics: The connection_statistics of this ConnectionStatisticsEntity. + :type: ConnectionStatisticsDTO + """ + + self._connection_statistics = connection_statistics + + @property + def can_read(self): + """ + Gets the can_read of this ConnectionStatisticsEntity. + Indicates whether the user can read a given resource. + + :return: The can_read of this ConnectionStatisticsEntity. + :rtype: bool + """ + return self._can_read + + @can_read.setter + def can_read(self, can_read): + """ + Sets the can_read of this ConnectionStatisticsEntity. + Indicates whether the user can read a given resource. + + :param can_read: The can_read of this ConnectionStatisticsEntity. + :type: bool + """ + + self._can_read = can_read + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatisticsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py new file mode 100644 index 00000000..98524fec --- /dev/null +++ b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py @@ -0,0 +1,321 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatisticsSnapshotDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'predicted_millis_until_count_backpressure': 'int', + 'predicted_millis_until_bytes_backpressure': 'int', + 'predicted_count_at_next_interval': 'int', + 'predicted_bytes_at_next_interval': 'int', + 'predicted_percent_count': 'int', + 'predicted_percent_bytes': 'int', + 'prediction_interval_millis': 'int' + } + + attribute_map = { + 'id': 'id', + 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', + 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', + 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', + 'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', + 'predicted_percent_count': 'predictedPercentCount', + 'predicted_percent_bytes': 'predictedPercentBytes', + 'prediction_interval_millis': 'predictionIntervalMillis' + } + + def __init__(self, id=None, predicted_millis_until_count_backpressure=None, predicted_millis_until_bytes_backpressure=None, predicted_count_at_next_interval=None, predicted_bytes_at_next_interval=None, predicted_percent_count=None, predicted_percent_bytes=None, prediction_interval_millis=None): + """ + ConnectionStatisticsSnapshotDTO - a model defined in Swagger + """ + + self._id = None + self._predicted_millis_until_count_backpressure = None + self._predicted_millis_until_bytes_backpressure = None + self._predicted_count_at_next_interval = None + self._predicted_bytes_at_next_interval = None + self._predicted_percent_count = None + self._predicted_percent_bytes = None + self._prediction_interval_millis = None + + if id is not None: + self.id = id + if predicted_millis_until_count_backpressure is not None: + self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + if predicted_millis_until_bytes_backpressure is not None: + self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + if predicted_count_at_next_interval is not None: + self.predicted_count_at_next_interval = predicted_count_at_next_interval + if predicted_bytes_at_next_interval is not None: + self.predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + if predicted_percent_count is not None: + self.predicted_percent_count = predicted_percent_count + if predicted_percent_bytes is not None: + self.predicted_percent_bytes = predicted_percent_bytes + if prediction_interval_millis is not None: + self.prediction_interval_millis = prediction_interval_millis + + @property + def id(self): + """ + Gets the id of this ConnectionStatisticsSnapshotDTO. + The id of the connection. + + :return: The id of this ConnectionStatisticsSnapshotDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ConnectionStatisticsSnapshotDTO. + The id of the connection. + + :param id: The id of this ConnectionStatisticsSnapshotDTO. + :type: str + """ + + self._id = id + + @property + def predicted_millis_until_count_backpressure(self): + """ + Gets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :return: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_count_backpressure + + @predicted_millis_until_count_backpressure.setter + def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): + """ + Sets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + + @property + def predicted_millis_until_bytes_backpressure(self): + """ + Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_bytes_backpressure + + @predicted_millis_until_bytes_backpressure.setter + def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): + """ + Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + + @property + def predicted_count_at_next_interval(self): + """ + Gets the predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :return: The predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_count_at_next_interval + + @predicted_count_at_next_interval.setter + def predicted_count_at_next_interval(self, predicted_count_at_next_interval): + """ + Sets the predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :param predicted_count_at_next_interval: The predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_count_at_next_interval = predicted_count_at_next_interval + + @property + def predicted_bytes_at_next_interval(self): + """ + Gets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :return: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_bytes_at_next_interval + + @predicted_bytes_at_next_interval.setter + def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): + """ + Sets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + + @property + def predicted_percent_count(self): + """ + Gets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of queued objects at the next configured interval. + + :return: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_count + + @predicted_percent_count.setter + def predicted_percent_count(self, predicted_percent_count): + """ + Sets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of queued objects at the next configured interval. + + :param predicted_percent_count: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_percent_count = predicted_percent_count + + @property + def predicted_percent_bytes(self): + """ + Gets the predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of bytes in the queue against current threshold at the next configured interval. + + :return: The predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_bytes + + @predicted_percent_bytes.setter + def predicted_percent_bytes(self, predicted_percent_bytes): + """ + Sets the predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of bytes in the queue against current threshold at the next configured interval. + + :param predicted_percent_bytes: The predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_percent_bytes = predicted_percent_bytes + + @property + def prediction_interval_millis(self): + """ + Gets the prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + The prediction interval in seconds + + :return: The prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._prediction_interval_millis + + @prediction_interval_millis.setter + def prediction_interval_millis(self, prediction_interval_millis): + """ + Sets the prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + The prediction interval in seconds + + :param prediction_interval_millis: The prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._prediction_interval_millis = prediction_interval_millis + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatisticsSnapshotDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_status_dto.py b/nipyapi/nifi/models/connection_status_dto.py index ae86ad22..81a5bffa 100644 --- a/nipyapi/nifi/models/connection_status_dto.py +++ b/nipyapi/nifi/models/connection_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_entity.py b/nipyapi/nifi/models/connection_status_entity.py index e1fe4431..78a92039 100644 --- a/nipyapi/nifi/models/connection_status_entity.py +++ b/nipyapi/nifi/models/connection_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py new file mode 100644 index 00000000..b0f0c195 --- /dev/null +++ b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatusPredictionsSnapshotDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'predicted_millis_until_count_backpressure': 'int', + 'predicted_millis_until_bytes_backpressure': 'int', + 'prediction_interval_seconds': 'int', + 'predicted_count_at_next_interval': 'int', + 'predicted_bytes_at_next_interval': 'int', + 'predicted_percent_count': 'int', + 'predicted_percent_bytes': 'int' + } + + attribute_map = { + 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', + 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', + 'prediction_interval_seconds': 'predictionIntervalSeconds', + 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', + 'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', + 'predicted_percent_count': 'predictedPercentCount', + 'predicted_percent_bytes': 'predictedPercentBytes' + } + + def __init__(self, predicted_millis_until_count_backpressure=None, predicted_millis_until_bytes_backpressure=None, prediction_interval_seconds=None, predicted_count_at_next_interval=None, predicted_bytes_at_next_interval=None, predicted_percent_count=None, predicted_percent_bytes=None): + """ + ConnectionStatusPredictionsSnapshotDTO - a model defined in Swagger + """ + + self._predicted_millis_until_count_backpressure = None + self._predicted_millis_until_bytes_backpressure = None + self._prediction_interval_seconds = None + self._predicted_count_at_next_interval = None + self._predicted_bytes_at_next_interval = None + self._predicted_percent_count = None + self._predicted_percent_bytes = None + + if predicted_millis_until_count_backpressure is not None: + self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + if predicted_millis_until_bytes_backpressure is not None: + self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + if prediction_interval_seconds is not None: + self.prediction_interval_seconds = prediction_interval_seconds + if predicted_count_at_next_interval is not None: + self.predicted_count_at_next_interval = predicted_count_at_next_interval + if predicted_bytes_at_next_interval is not None: + self.predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + if predicted_percent_count is not None: + self.predicted_percent_count = predicted_percent_count + if predicted_percent_bytes is not None: + self.predicted_percent_bytes = predicted_percent_bytes + + @property + def predicted_millis_until_count_backpressure(self): + """ + Gets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :return: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_count_backpressure + + @predicted_millis_until_count_backpressure.setter + def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): + """ + Sets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + + @property + def predicted_millis_until_bytes_backpressure(self): + """ + Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_bytes_backpressure + + @predicted_millis_until_bytes_backpressure.setter + def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): + """ + Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + + @property + def prediction_interval_seconds(self): + """ + Gets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + The configured interval (in seconds) for predicting connection queue count and size (and percent usage). + + :return: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._prediction_interval_seconds + + @prediction_interval_seconds.setter + def prediction_interval_seconds(self, prediction_interval_seconds): + """ + Sets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + The configured interval (in seconds) for predicting connection queue count and size (and percent usage). + + :param prediction_interval_seconds: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._prediction_interval_seconds = prediction_interval_seconds + + @property + def predicted_count_at_next_interval(self): + """ + Gets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :return: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_count_at_next_interval + + @predicted_count_at_next_interval.setter + def predicted_count_at_next_interval(self, predicted_count_at_next_interval): + """ + Sets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :param predicted_count_at_next_interval: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_count_at_next_interval = predicted_count_at_next_interval + + @property + def predicted_bytes_at_next_interval(self): + """ + Gets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :return: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_bytes_at_next_interval + + @predicted_bytes_at_next_interval.setter + def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): + """ + Sets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + + @property + def predicted_percent_count(self): + """ + Gets the predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files count and backpressure threshold if configured. + + :return: The predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_count + + @predicted_percent_count.setter + def predicted_percent_count(self, predicted_percent_count): + """ + Sets the predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files count and backpressure threshold if configured. + + :param predicted_percent_count: The predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_percent_count = predicted_percent_count + + @property + def predicted_percent_bytes(self): + """ + Gets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. + + :return: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_bytes + + @predicted_percent_bytes.setter + def predicted_percent_bytes(self, predicted_percent_bytes): + """ + Sets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. + + :param predicted_percent_bytes: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_percent_bytes = predicted_percent_bytes + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatusPredictionsSnapshotDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_status_snapshot_dto.py b/nipyapi/nifi/models/connection_status_snapshot_dto.py index 60d37bee..69cf8c94 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,6 +38,7 @@ class ConnectionStatusSnapshotDTO(object): 'source_name': 'str', 'destination_id': 'str', 'destination_name': 'str', + 'predictions': 'ConnectionStatusPredictionsSnapshotDTO', 'flow_files_in': 'int', 'bytes_in': 'int', 'input': 'str', @@ -61,6 +62,7 @@ class ConnectionStatusSnapshotDTO(object): 'source_name': 'sourceName', 'destination_id': 'destinationId', 'destination_name': 'destinationName', + 'predictions': 'predictions', 'flow_files_in': 'flowFilesIn', 'bytes_in': 'bytesIn', 'input': 'input', @@ -76,7 +78,7 @@ class ConnectionStatusSnapshotDTO(object): 'percent_use_bytes': 'percentUseBytes' } - def __init__(self, id=None, group_id=None, name=None, source_id=None, source_name=None, destination_id=None, destination_name=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): + def __init__(self, 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): """ ConnectionStatusSnapshotDTO - a model defined in Swagger """ @@ -88,6 +90,7 @@ def __init__(self, id=None, group_id=None, name=None, source_id=None, source_nam self._source_name = None self._destination_id = None self._destination_name = None + self._predictions = None self._flow_files_in = None self._bytes_in = None self._input = None @@ -116,6 +119,8 @@ def __init__(self, id=None, group_id=None, name=None, source_id=None, source_nam self.destination_id = destination_id if destination_name is not None: self.destination_name = destination_name + if predictions is not None: + self.predictions = predictions if flow_files_in is not None: self.flow_files_in = flow_files_in if bytes_in is not None: @@ -304,6 +309,29 @@ def destination_name(self, destination_name): self._destination_name = destination_name + @property + def predictions(self): + """ + Gets the predictions of this ConnectionStatusSnapshotDTO. + Predictions, if available, for this connection (null if not available) + + :return: The predictions of this ConnectionStatusSnapshotDTO. + :rtype: ConnectionStatusPredictionsSnapshotDTO + """ + return self._predictions + + @predictions.setter + def predictions(self, predictions): + """ + Sets the predictions of this ConnectionStatusSnapshotDTO. + Predictions, if available, for this connection (null if not available) + + :param predictions: The predictions of this ConnectionStatusSnapshotDTO. + :type: ConnectionStatusPredictionsSnapshotDTO + """ + + self._predictions = predictions + @property def flow_files_in(self): """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_entity.py b/nipyapi/nifi/models/connection_status_snapshot_entity.py index 58b3e42a..efc4d104 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_entity.py +++ b/nipyapi/nifi/models/connection_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connections_entity.py b/nipyapi/nifi/models/connections_entity.py index a0694bcf..6c4dc8c2 100644 --- a/nipyapi/nifi/models/connections_entity.py +++ b/nipyapi/nifi/models/connections_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_bulletins_entity.py b/nipyapi/nifi/models/controller_bulletins_entity.py index 73be4e70..91d1279b 100644 --- a/nipyapi/nifi/models/controller_bulletins_entity.py +++ b/nipyapi/nifi/models/controller_bulletins_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_dto.py b/nipyapi/nifi/models/controller_configuration_dto.py index 4a7ec25e..7f9027b8 100644 --- a/nipyapi/nifi/models/controller_configuration_dto.py +++ b/nipyapi/nifi/models/controller_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_entity.py b/nipyapi/nifi/models/controller_configuration_entity.py index 1ec6e09e..bcdf8057 100644 --- a/nipyapi/nifi/models/controller_configuration_entity.py +++ b/nipyapi/nifi/models/controller_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_dto.py b/nipyapi/nifi/models/controller_dto.py index 95d4d454..a6323e65 100644 --- a/nipyapi/nifi/models/controller_dto.py +++ b/nipyapi/nifi/models/controller_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_entity.py b/nipyapi/nifi/models/controller_entity.py index 5a75e56f..6b0425a5 100644 --- a/nipyapi/nifi/models/controller_entity.py +++ b/nipyapi/nifi/models/controller_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api.py b/nipyapi/nifi/models/controller_service_api.py index 5f26195a..2f65f9c2 100644 --- a/nipyapi/nifi/models/controller_service_api.py +++ b/nipyapi/nifi/models/controller_service_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api_dto.py b/nipyapi/nifi/models/controller_service_api_dto.py index d100c51f..df3949db 100644 --- a/nipyapi/nifi/models/controller_service_api_dto.py +++ b/nipyapi/nifi/models/controller_service_api_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_dto.py b/nipyapi/nifi/models/controller_service_dto.py index 21b08196..03b73ce1 100644 --- a/nipyapi/nifi/models/controller_service_dto.py +++ b/nipyapi/nifi/models/controller_service_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_entity.py b/nipyapi/nifi/models/controller_service_entity.py index a762a354..67a556da 100644 --- a/nipyapi/nifi/models/controller_service_entity.py +++ b/nipyapi/nifi/models/controller_service_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index e7fb96fb..0e8d9be1 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -307,7 +307,6 @@ def reference_type(self, reference_type): :param reference_type: The reference_type of this ControllerServiceReferencingComponentDTO. :type: str """ - # allowed_values = ["Processor", "ControllerService", "or ReportingTask"] allowed_values = ["Processor", "ControllerService", "ReportingTask"] if reference_type not in allowed_values: raise ValueError( diff --git a/nipyapi/nifi/models/controller_service_referencing_component_entity.py b/nipyapi/nifi/models/controller_service_referencing_component_entity.py index 519a71df..97f99368 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_components_entity.py b/nipyapi/nifi/models/controller_service_referencing_components_entity.py index 94e0a01a..8e64ba56 100644 --- a/nipyapi/nifi/models/controller_service_referencing_components_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_run_status_entity.py b/nipyapi/nifi/models/controller_service_run_status_entity.py index c5774c39..bf397a0f 100644 --- a/nipyapi/nifi/models/controller_service_run_status_entity.py +++ b/nipyapi/nifi/models/controller_service_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_status_dto.py b/nipyapi/nifi/models/controller_service_status_dto.py index 0ddf7765..29e5f2e5 100644 --- a/nipyapi/nifi/models/controller_service_status_dto.py +++ b/nipyapi/nifi/models/controller_service_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_types_entity.py b/nipyapi/nifi/models/controller_service_types_entity.py index 590efd35..acd601f2 100644 --- a/nipyapi/nifi/models/controller_service_types_entity.py +++ b/nipyapi/nifi/models/controller_service_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_services_entity.py b/nipyapi/nifi/models/controller_services_entity.py index e5bdc6e1..b7808043 100644 --- a/nipyapi/nifi/models/controller_services_entity.py +++ b/nipyapi/nifi/models/controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_dto.py b/nipyapi/nifi/models/controller_status_dto.py index 557ed827..f7080ea2 100644 --- a/nipyapi/nifi/models/controller_status_dto.py +++ b/nipyapi/nifi/models/controller_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_entity.py b/nipyapi/nifi/models/controller_status_entity.py index 98777586..0e4f3ea8 100644 --- a/nipyapi/nifi/models/controller_status_entity.py +++ b/nipyapi/nifi/models/controller_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/copy_snippet_request_entity.py b/nipyapi/nifi/models/copy_snippet_request_entity.py index f2d5d115..65f2161c 100644 --- a/nipyapi/nifi/models/copy_snippet_request_entity.py +++ b/nipyapi/nifi/models/copy_snippet_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_dto.py b/nipyapi/nifi/models/counter_dto.py index edc58139..1599c822 100644 --- a/nipyapi/nifi/models/counter_dto.py +++ b/nipyapi/nifi/models/counter_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_entity.py b/nipyapi/nifi/models/counter_entity.py index ed95c295..283a01fc 100644 --- a/nipyapi/nifi/models/counter_entity.py +++ b/nipyapi/nifi/models/counter_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_dto.py b/nipyapi/nifi/models/counters_dto.py index 66b8f8ba..bf53305c 100644 --- a/nipyapi/nifi/models/counters_dto.py +++ b/nipyapi/nifi/models/counters_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_entity.py b/nipyapi/nifi/models/counters_entity.py index 1edc475b..5b654a09 100644 --- a/nipyapi/nifi/models/counters_entity.py +++ b/nipyapi/nifi/models/counters_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_snapshot_dto.py b/nipyapi/nifi/models/counters_snapshot_dto.py index f2ed4de1..fc3e5c15 100644 --- a/nipyapi/nifi/models/counters_snapshot_dto.py +++ b/nipyapi/nifi/models/counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_active_request_entity.py b/nipyapi/nifi/models/create_active_request_entity.py index 29e3fb4c..4ed96bb0 100644 --- a/nipyapi/nifi/models/create_active_request_entity.py +++ b/nipyapi/nifi/models/create_active_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_template_request_entity.py b/nipyapi/nifi/models/create_template_request_entity.py index bde391e1..0cce1072 100644 --- a/nipyapi/nifi/models/create_template_request_entity.py +++ b/nipyapi/nifi/models/create_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/current_user_entity.py b/nipyapi/nifi/models/current_user_entity.py index ccc5d275..3c821993 100644 --- a/nipyapi/nifi/models/current_user_entity.py +++ b/nipyapi/nifi/models/current_user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -39,6 +39,7 @@ class CurrentUserEntity(object): 'controller_permissions': 'PermissionsDTO', 'policies_permissions': 'PermissionsDTO', 'system_permissions': 'PermissionsDTO', + 'parameter_context_permissions': 'PermissionsDTO', 'restricted_components_permissions': 'PermissionsDTO', 'component_restriction_permissions': 'list[ComponentRestrictionPermissionDTO]', 'can_version_flows': 'bool' @@ -53,12 +54,13 @@ class CurrentUserEntity(object): 'controller_permissions': 'controllerPermissions', 'policies_permissions': 'policiesPermissions', 'system_permissions': 'systemPermissions', + 'parameter_context_permissions': 'parameterContextPermissions', 'restricted_components_permissions': 'restrictedComponentsPermissions', 'component_restriction_permissions': 'componentRestrictionPermissions', 'can_version_flows': 'canVersionFlows' } - def __init__(self, identity=None, anonymous=None, provenance_permissions=None, counters_permissions=None, tenants_permissions=None, controller_permissions=None, policies_permissions=None, system_permissions=None, restricted_components_permissions=None, component_restriction_permissions=None, can_version_flows=None): + def __init__(self, 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): """ CurrentUserEntity - a model defined in Swagger """ @@ -71,6 +73,7 @@ def __init__(self, identity=None, anonymous=None, provenance_permissions=None, c self._controller_permissions = None self._policies_permissions = None self._system_permissions = None + self._parameter_context_permissions = None self._restricted_components_permissions = None self._component_restriction_permissions = None self._can_version_flows = None @@ -91,6 +94,8 @@ def __init__(self, identity=None, anonymous=None, provenance_permissions=None, c self.policies_permissions = policies_permissions if system_permissions is not None: self.system_permissions = system_permissions + if parameter_context_permissions is not None: + self.parameter_context_permissions = parameter_context_permissions if restricted_components_permissions is not None: self.restricted_components_permissions = restricted_components_permissions if component_restriction_permissions is not None: @@ -282,6 +287,29 @@ def system_permissions(self, system_permissions): self._system_permissions = system_permissions + @property + def parameter_context_permissions(self): + """ + Gets the parameter_context_permissions of this CurrentUserEntity. + Permissions for accessing parameter contexts. + + :return: The parameter_context_permissions of this CurrentUserEntity. + :rtype: PermissionsDTO + """ + return self._parameter_context_permissions + + @parameter_context_permissions.setter + def parameter_context_permissions(self, parameter_context_permissions): + """ + Sets the parameter_context_permissions of this CurrentUserEntity. + Permissions for accessing parameter contexts. + + :param parameter_context_permissions: The parameter_context_permissions of this CurrentUserEntity. + :type: PermissionsDTO + """ + + self._parameter_context_permissions = parameter_context_permissions + @property def restricted_components_permissions(self): """ diff --git a/nipyapi/nifi/models/difference_dto.py b/nipyapi/nifi/models/difference_dto.py index 85415128..3fe97fd8 100644 --- a/nipyapi/nifi/models/difference_dto.py +++ b/nipyapi/nifi/models/difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dimensions_dto.py b/nipyapi/nifi/models/dimensions_dto.py index 7dee9d4b..41cbce0d 100644 --- a/nipyapi/nifi/models/dimensions_dto.py +++ b/nipyapi/nifi/models/dimensions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/documented_type_dto.py b/nipyapi/nifi/models/documented_type_dto.py index 4d3be02d..231134ec 100644 --- a/nipyapi/nifi/models/documented_type_dto.py +++ b/nipyapi/nifi/models/documented_type_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_dto.py b/nipyapi/nifi/models/drop_request_dto.py index c95c34f6..250e4077 100644 --- a/nipyapi/nifi/models/drop_request_dto.py +++ b/nipyapi/nifi/models/drop_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_entity.py b/nipyapi/nifi/models/drop_request_entity.py index a2ad48c2..cc3f3df7 100644 --- a/nipyapi/nifi/models/drop_request_entity.py +++ b/nipyapi/nifi/models/drop_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/explicit_restriction_dto.py b/nipyapi/nifi/models/explicit_restriction_dto.py index 6464f641..c42d27e9 100644 --- a/nipyapi/nifi/models/explicit_restriction_dto.py +++ b/nipyapi/nifi/models/explicit_restriction_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/external_controller_service_reference.py b/nipyapi/nifi/models/external_controller_service_reference.py new file mode 100644 index 00000000..54689294 --- /dev/null +++ b/nipyapi/nifi/models/external_controller_service_reference.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExternalControllerServiceReference(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'identifier': 'str', + 'name': 'str' + } + + attribute_map = { + 'identifier': 'identifier', + 'name': 'name' + } + + def __init__(self, identifier=None, name=None): + """ + ExternalControllerServiceReference - a model defined in Swagger + """ + + self._identifier = None + self._name = None + + if identifier is not None: + self.identifier = identifier + if name is not None: + self.name = name + + @property + def identifier(self): + """ + Gets the identifier of this ExternalControllerServiceReference. + The identifier of the controller service + + :return: The identifier of this ExternalControllerServiceReference. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ExternalControllerServiceReference. + The identifier of the controller service + + :param identifier: The identifier of this ExternalControllerServiceReference. + :type: str + """ + + self._identifier = identifier + + @property + def name(self): + """ + Gets the name of this ExternalControllerServiceReference. + The name of the controller service + + :return: The name of this ExternalControllerServiceReference. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ExternalControllerServiceReference. + The name of the controller service + + :param name: The name of this ExternalControllerServiceReference. + :type: str + """ + + self._name = name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExternalControllerServiceReference): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_breadcrumb_dto.py b/nipyapi/nifi/models/flow_breadcrumb_dto.py index 7978e7ca..4bb3fccc 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_dto.py +++ b/nipyapi/nifi/models/flow_breadcrumb_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_entity.py b/nipyapi/nifi/models/flow_breadcrumb_entity.py index 88928c06..37ece9f9 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_entity.py +++ b/nipyapi/nifi/models/flow_breadcrumb_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_comparison_entity.py b/nipyapi/nifi/models/flow_comparison_entity.py index 454ffcaf..6ffc4b10 100644 --- a/nipyapi/nifi/models/flow_comparison_entity.py +++ b/nipyapi/nifi/models/flow_comparison_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_dto.py b/nipyapi/nifi/models/flow_configuration_dto.py index e338f1c8..df9fd085 100644 --- a/nipyapi/nifi/models/flow_configuration_dto.py +++ b/nipyapi/nifi/models/flow_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_entity.py b/nipyapi/nifi/models/flow_configuration_entity.py index 5812c601..0ad226de 100644 --- a/nipyapi/nifi/models/flow_configuration_entity.py +++ b/nipyapi/nifi/models/flow_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_dto.py b/nipyapi/nifi/models/flow_dto.py index 2bc1d7fd..60d28e3e 100644 --- a/nipyapi/nifi/models/flow_dto.py +++ b/nipyapi/nifi/models/flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_entity.py b/nipyapi/nifi/models/flow_entity.py index ca3dddda..d67c0175 100644 --- a/nipyapi/nifi/models/flow_entity.py +++ b/nipyapi/nifi/models/flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_dto.py b/nipyapi/nifi/models/flow_file_dto.py index f0dd23f2..f4da0192 100644 --- a/nipyapi/nifi/models/flow_file_dto.py +++ b/nipyapi/nifi/models/flow_file_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_entity.py b/nipyapi/nifi/models/flow_file_entity.py index b146c4f2..c801cb97 100644 --- a/nipyapi/nifi/models/flow_file_entity.py +++ b/nipyapi/nifi/models/flow_file_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_summary_dto.py b/nipyapi/nifi/models/flow_file_summary_dto.py index 135e546a..1cafbdfd 100644 --- a/nipyapi/nifi/models/flow_file_summary_dto.py +++ b/nipyapi/nifi/models/flow_file_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_snippet_dto.py b/nipyapi/nifi/models/flow_snippet_dto.py index 9488c390..335180df 100644 --- a/nipyapi/nifi/models/flow_snippet_dto.py +++ b/nipyapi/nifi/models/flow_snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_dto.py b/nipyapi/nifi/models/funnel_dto.py index 4256f56b..b68d495c 100644 --- a/nipyapi/nifi/models/funnel_dto.py +++ b/nipyapi/nifi/models/funnel_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_entity.py b/nipyapi/nifi/models/funnel_entity.py index 6e0e313d..3594cc5d 100644 --- a/nipyapi/nifi/models/funnel_entity.py +++ b/nipyapi/nifi/models/funnel_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnels_entity.py b/nipyapi/nifi/models/funnels_entity.py index 49d8a429..76031142 100644 --- a/nipyapi/nifi/models/funnels_entity.py +++ b/nipyapi/nifi/models/funnels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/garbage_collection_dto.py b/nipyapi/nifi/models/garbage_collection_dto.py index db373915..ad92cbd3 100644 --- a/nipyapi/nifi/models/garbage_collection_dto.py +++ b/nipyapi/nifi/models/garbage_collection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_dto.py b/nipyapi/nifi/models/history_dto.py index 246c0198..8af6f1f1 100644 --- a/nipyapi/nifi/models/history_dto.py +++ b/nipyapi/nifi/models/history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_entity.py b/nipyapi/nifi/models/history_entity.py index 85578d00..ed06f473 100644 --- a/nipyapi/nifi/models/history_entity.py +++ b/nipyapi/nifi/models/history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/input_ports_entity.py b/nipyapi/nifi/models/input_ports_entity.py index 301b901d..1bb7048d 100644 --- a/nipyapi/nifi/models/input_ports_entity.py +++ b/nipyapi/nifi/models/input_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/instantiate_template_request_entity.py b/nipyapi/nifi/models/instantiate_template_request_entity.py index 37b884ad..a1c39649 100644 --- a/nipyapi/nifi/models/instantiate_template_request_entity.py +++ b/nipyapi/nifi/models/instantiate_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/uri_builder.py b/nipyapi/nifi/models/jaxb_link.py similarity index 64% rename from nipyapi/nifi/models/uri_builder.py rename to nipyapi/nifi/models/jaxb_link.py index 1bd08d62..03acc670 100644 --- a/nipyapi/nifi/models/uri_builder.py +++ b/nipyapi/nifi/models/jaxb_link.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -16,7 +16,7 @@ import re -class UriBuilder(object): +class JaxbLink(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -31,19 +31,73 @@ class UriBuilder(object): and the value is json key in definition. """ swagger_types = { - + 'href': 'str', + 'params': 'dict(str, str)' } attribute_map = { - + 'href': 'href', + 'params': 'params' } - def __init__(self): + def __init__(self, href=None, params=None): """ - UriBuilder - a model defined in Swagger + JaxbLink - a model defined in Swagger """ + self._href = None + self._params = None + if href is not None: + self.href = href + if params is not None: + self.params = params + + @property + def href(self): + """ + Gets the href of this JaxbLink. + The href for the link + + :return: The href of this JaxbLink. + :rtype: str + """ + return self._href + + @href.setter + def href(self, href): + """ + Sets the href of this JaxbLink. + The href for the link + + :param href: The href of this JaxbLink. + :type: str + """ + + self._href = href + + @property + def params(self): + """ + Gets the params of this JaxbLink. + The params for the link + + :return: The params of this JaxbLink. + :rtype: dict(str, str) + """ + return self._params + + @params.setter + def params(self, params): + """ + Sets the params of this JaxbLink. + The params for the link + + :param params: The params of this JaxbLink. + :type: dict(str, str) + """ + + self._params = params def to_dict(self): """ @@ -87,7 +141,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, UriBuilder): + if not isinstance(other, JaxbLink): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/label_dto.py b/nipyapi/nifi/models/label_dto.py index 4e73d018..e64b0090 100644 --- a/nipyapi/nifi/models/label_dto.py +++ b/nipyapi/nifi/models/label_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_entity.py b/nipyapi/nifi/models/label_entity.py index 50d8f0c8..36f855b6 100644 --- a/nipyapi/nifi/models/label_entity.py +++ b/nipyapi/nifi/models/label_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/labels_entity.py b/nipyapi/nifi/models/labels_entity.py index 0120ab24..162df91b 100644 --- a/nipyapi/nifi/models/labels_entity.py +++ b/nipyapi/nifi/models/labels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_dto.py b/nipyapi/nifi/models/lineage_dto.py index 90edea91..f42a5672 100644 --- a/nipyapi/nifi/models/lineage_dto.py +++ b/nipyapi/nifi/models/lineage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_entity.py b/nipyapi/nifi/models/lineage_entity.py index 30923dbb..88f8d4da 100644 --- a/nipyapi/nifi/models/lineage_entity.py +++ b/nipyapi/nifi/models/lineage_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_request_dto.py b/nipyapi/nifi/models/lineage_request_dto.py index d3919959..bcbb3def 100644 --- a/nipyapi/nifi/models/lineage_request_dto.py +++ b/nipyapi/nifi/models/lineage_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_results_dto.py b/nipyapi/nifi/models/lineage_results_dto.py index 6e4b5fd7..48a5df68 100644 --- a/nipyapi/nifi/models/lineage_results_dto.py +++ b/nipyapi/nifi/models/lineage_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/link.py b/nipyapi/nifi/models/link.py deleted file mode 100644 index 95f2c7e2..00000000 --- a/nipyapi/nifi/models/link.py +++ /dev/null @@ -1,279 +0,0 @@ -# coding: utf-8 - -""" - NiFi Rest Api - - The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.9.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -from six import iteritems -import re - - -class Link(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'type': 'str', - 'title': 'str', - 'rel': 'str', - 'rels': 'list[str]', - 'uri_builder': 'UriBuilder', - 'params': 'dict(str, str)', - 'uri': 'str' - } - - attribute_map = { - 'type': 'type', - 'title': 'title', - 'rel': 'rel', - 'rels': 'rels', - 'uri_builder': 'uriBuilder', - 'params': 'params', - 'uri': 'uri' - } - - def __init__(self, type=None, title=None, rel=None, rels=None, uri_builder=None, params=None, uri=None): - """ - Link - a model defined in Swagger - """ - - self._type = None - self._title = None - self._rel = None - self._rels = None - self._uri_builder = None - self._params = None - self._uri = None - - if type is not None: - self.type = type - if title is not None: - self.title = title - if rel is not None: - self.rel = rel - if rels is not None: - self.rels = rels - if uri_builder is not None: - self.uri_builder = uri_builder - if params is not None: - self.params = params - if uri is not None: - self.uri = uri - - @property - def type(self): - """ - Gets the type of this Link. - - :return: The type of this Link. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this Link. - - :param type: The type of this Link. - :type: str - """ - - self._type = type - - @property - def title(self): - """ - Gets the title of this Link. - - :return: The title of this Link. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this Link. - - :param title: The title of this Link. - :type: str - """ - - self._title = title - - @property - def rel(self): - """ - Gets the rel of this Link. - - :return: The rel of this Link. - :rtype: str - """ - return self._rel - - @rel.setter - def rel(self, rel): - """ - Sets the rel of this Link. - - :param rel: The rel of this Link. - :type: str - """ - - self._rel = rel - - @property - def rels(self): - """ - Gets the rels of this Link. - - :return: The rels of this Link. - :rtype: list[str] - """ - return self._rels - - @rels.setter - def rels(self, rels): - """ - Sets the rels of this Link. - - :param rels: The rels of this Link. - :type: list[str] - """ - - self._rels = rels - - @property - def uri_builder(self): - """ - Gets the uri_builder of this Link. - - :return: The uri_builder of this Link. - :rtype: UriBuilder - """ - return self._uri_builder - - @uri_builder.setter - def uri_builder(self, uri_builder): - """ - Sets the uri_builder of this Link. - - :param uri_builder: The uri_builder of this Link. - :type: UriBuilder - """ - - self._uri_builder = uri_builder - - @property - def params(self): - """ - Gets the params of this Link. - - :return: The params of this Link. - :rtype: dict(str, str) - """ - return self._params - - @params.setter - def params(self, params): - """ - Sets the params of this Link. - - :param params: The params of this Link. - :type: dict(str, str) - """ - - self._params = params - - @property - def uri(self): - """ - Gets the uri of this Link. - - :return: The uri of this Link. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this Link. - - :param uri: The uri of this Link. - :type: str - """ - - self._uri = uri - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - if not isinstance(other, Link): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/listing_request_dto.py b/nipyapi/nifi/models/listing_request_dto.py index 2decdace..4bf6521e 100644 --- a/nipyapi/nifi/models/listing_request_dto.py +++ b/nipyapi/nifi/models/listing_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/listing_request_entity.py b/nipyapi/nifi/models/listing_request_entity.py index cf3e45e7..e4341608 100644 --- a/nipyapi/nifi/models/listing_request_entity.py +++ b/nipyapi/nifi/models/listing_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py new file mode 100644 index 00000000..de6968ba --- /dev/null +++ b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class NodeConnectionStatisticsSnapshotDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'node_id': 'str', + 'address': 'str', + 'api_port': 'int', + 'statistics_snapshot': 'ConnectionStatisticsSnapshotDTO' + } + + attribute_map = { + 'node_id': 'nodeId', + 'address': 'address', + 'api_port': 'apiPort', + 'statistics_snapshot': 'statisticsSnapshot' + } + + def __init__(self, node_id=None, address=None, api_port=None, statistics_snapshot=None): + """ + NodeConnectionStatisticsSnapshotDTO - a model defined in Swagger + """ + + self._node_id = None + self._address = None + self._api_port = None + self._statistics_snapshot = None + + if node_id is not None: + self.node_id = node_id + if address is not None: + self.address = address + if api_port is not None: + self.api_port = api_port + if statistics_snapshot is not None: + self.statistics_snapshot = statistics_snapshot + + @property + def node_id(self): + """ + Gets the node_id of this NodeConnectionStatisticsSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeConnectionStatisticsSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeConnectionStatisticsSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeConnectionStatisticsSnapshotDTO. + :type: str + """ + + self._node_id = node_id + + @property + def address(self): + """ + Gets the address of this NodeConnectionStatisticsSnapshotDTO. + The API address of the node + + :return: The address of this NodeConnectionStatisticsSnapshotDTO. + :rtype: str + """ + return self._address + + @address.setter + def address(self, address): + """ + Sets the address of this NodeConnectionStatisticsSnapshotDTO. + The API address of the node + + :param address: The address of this NodeConnectionStatisticsSnapshotDTO. + :type: str + """ + + self._address = address + + @property + def api_port(self): + """ + Gets the api_port of this NodeConnectionStatisticsSnapshotDTO. + The API port used to communicate with the node + + :return: The api_port of this NodeConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._api_port + + @api_port.setter + def api_port(self, api_port): + """ + Sets the api_port of this NodeConnectionStatisticsSnapshotDTO. + The API port used to communicate with the node + + :param api_port: The api_port of this NodeConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._api_port = api_port + + @property + def statistics_snapshot(self): + """ + Gets the statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + The connection status snapshot from the node. + + :return: The statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + :rtype: ConnectionStatisticsSnapshotDTO + """ + return self._statistics_snapshot + + @statistics_snapshot.setter + def statistics_snapshot(self, statistics_snapshot): + """ + Sets the statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + The connection status snapshot from the node. + + :param statistics_snapshot: The statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + :type: ConnectionStatisticsSnapshotDTO + """ + + self._statistics_snapshot = statistics_snapshot + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, NodeConnectionStatisticsSnapshotDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py index 0a8a8baa..890a1129 100644 --- a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_counters_snapshot_dto.py b/nipyapi/nifi/models/node_counters_snapshot_dto.py index ff82da87..34f2932c 100644 --- a/nipyapi/nifi/models/node_counters_snapshot_dto.py +++ b/nipyapi/nifi/models/node_counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_dto.py b/nipyapi/nifi/models/node_dto.py index b7ea4a7b..bdcad7e2 100644 --- a/nipyapi/nifi/models/node_dto.py +++ b/nipyapi/nifi/models/node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_entity.py b/nipyapi/nifi/models/node_entity.py index f99f64a5..e18b6f8e 100644 --- a/nipyapi/nifi/models/node_entity.py +++ b/nipyapi/nifi/models/node_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_event_dto.py b/nipyapi/nifi/models/node_event_dto.py index d9d91a53..7ce20901 100644 --- a/nipyapi/nifi/models/node_event_dto.py +++ b/nipyapi/nifi/models/node_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_port_status_snapshot_dto.py b/nipyapi/nifi/models/node_port_status_snapshot_dto.py index 74dcd6fc..e5cc20d6 100644 --- a/nipyapi/nifi/models/node_port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py index 736075bd..2adb8225 100644 --- a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py index b0788f82..58238a02 100644 --- a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py index 85178122..f4238dab 100644 --- a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_search_result_dto.py b/nipyapi/nifi/models/node_search_result_dto.py index d69944ff..0bb54c11 100644 --- a/nipyapi/nifi/models/node_search_result_dto.py +++ b/nipyapi/nifi/models/node_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_status_snapshots_dto.py b/nipyapi/nifi/models/node_status_snapshots_dto.py index befd2c6d..3f387047 100644 --- a/nipyapi/nifi/models/node_status_snapshots_dto.py +++ b/nipyapi/nifi/models/node_status_snapshots_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py index 9daacf80..d6dacd20 100644 --- a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/output_ports_entity.py b/nipyapi/nifi/models/output_ports_entity.py index 3da899f1..87cfe258 100644 --- a/nipyapi/nifi/models/output_ports_entity.py +++ b/nipyapi/nifi/models/output_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_dto.py b/nipyapi/nifi/models/parameter_context_dto.py new file mode 100644 index 00000000..782aa577 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_dto.py @@ -0,0 +1,237 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'parameters': 'list[ParameterEntity]', + 'bound_process_groups': 'list[ProcessGroupEntity]', + 'id': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'parameters': 'parameters', + 'bound_process_groups': 'boundProcessGroups', + 'id': 'id' + } + + def __init__(self, name=None, description=None, parameters=None, bound_process_groups=None, id=None): + """ + ParameterContextDTO - a model defined in Swagger + """ + + self._name = None + self._description = None + self._parameters = None + self._bound_process_groups = None + self._id = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if parameters is not None: + self.parameters = parameters + if bound_process_groups is not None: + self.bound_process_groups = bound_process_groups + if id is not None: + self.id = id + + @property + def name(self): + """ + Gets the name of this ParameterContextDTO. + The Name of the Parameter Context. + + :return: The name of this ParameterContextDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ParameterContextDTO. + The Name of the Parameter Context. + + :param name: The name of this ParameterContextDTO. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this ParameterContextDTO. + The Description of the Parameter Context. + + :return: The description of this ParameterContextDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextDTO. + The Description of the Parameter Context. + + :param description: The description of this ParameterContextDTO. + :type: str + """ + + self._description = description + + @property + def parameters(self): + """ + Gets the parameters of this ParameterContextDTO. + The Parameters for the Parameter Context + + :return: The parameters of this ParameterContextDTO. + :rtype: list[ParameterEntity] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this ParameterContextDTO. + The Parameters for the Parameter Context + + :param parameters: The parameters of this ParameterContextDTO. + :type: list[ParameterEntity] + """ + + self._parameters = parameters + + @property + def bound_process_groups(self): + """ + Gets the bound_process_groups of this ParameterContextDTO. + The Process Groups that are bound to this Parameter Context + + :return: The bound_process_groups of this ParameterContextDTO. + :rtype: list[ProcessGroupEntity] + """ + return self._bound_process_groups + + @bound_process_groups.setter + def bound_process_groups(self, bound_process_groups): + """ + Sets the bound_process_groups of this ParameterContextDTO. + The Process Groups that are bound to this Parameter Context + + :param bound_process_groups: The bound_process_groups of this ParameterContextDTO. + :type: list[ProcessGroupEntity] + """ + + self._bound_process_groups = bound_process_groups + + @property + def id(self): + """ + Gets the id of this ParameterContextDTO. + The ID the Parameter Context. + + :return: The id of this ParameterContextDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextDTO. + The ID the Parameter Context. + + :param id: The id of this ParameterContextDTO. + :type: str + """ + + self._id = id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_entity.py b/nipyapi/nifi/models/parameter_context_entity.py new file mode 100644 index 00000000..f1e2314a --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_entity.py @@ -0,0 +1,321 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'revision': 'RevisionDTO', + 'id': 'str', + 'uri': 'str', + 'position': 'PositionDTO', + 'permissions': 'PermissionsDTO', + 'bulletins': 'list[BulletinEntity]', + 'disconnected_node_acknowledged': 'bool', + 'component': 'ParameterContextDTO' + } + + attribute_map = { + 'revision': 'revision', + 'id': 'id', + 'uri': 'uri', + 'position': 'position', + 'permissions': 'permissions', + 'bulletins': 'bulletins', + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', + 'component': 'component' + } + + def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + """ + ParameterContextEntity - a model defined in Swagger + """ + + self._revision = None + self._id = None + self._uri = None + self._position = None + self._permissions = None + self._bulletins = None + self._disconnected_node_acknowledged = None + self._component = None + + if revision is not None: + self.revision = revision + if id is not None: + self.id = id + if uri is not None: + self.uri = uri + if position is not None: + self.position = position + if permissions is not None: + self.permissions = permissions + if bulletins is not None: + self.bulletins = bulletins + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if component is not None: + self.component = component + + @property + def revision(self): + """ + Gets the revision of this ParameterContextEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :return: The revision of this ParameterContextEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ParameterContextEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :param revision: The revision of this ParameterContextEntity. + :type: RevisionDTO + """ + + self._revision = revision + + @property + def id(self): + """ + Gets the id of this ParameterContextEntity. + The id of the component. + + :return: The id of this ParameterContextEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextEntity. + The id of the component. + + :param id: The id of this ParameterContextEntity. + :type: str + """ + + self._id = id + + @property + def uri(self): + """ + Gets the uri of this ParameterContextEntity. + The URI for futures requests to the component. + + :return: The uri of this ParameterContextEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ParameterContextEntity. + The URI for futures requests to the component. + + :param uri: The uri of this ParameterContextEntity. + :type: str + """ + + self._uri = uri + + @property + def position(self): + """ + Gets the position of this ParameterContextEntity. + The position of this component in the UI if applicable. + + :return: The position of this ParameterContextEntity. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this ParameterContextEntity. + The position of this component in the UI if applicable. + + :param position: The position of this ParameterContextEntity. + :type: PositionDTO + """ + + self._position = position + + @property + def permissions(self): + """ + Gets the permissions of this ParameterContextEntity. + The permissions for this component. + + :return: The permissions of this ParameterContextEntity. + :rtype: PermissionsDTO + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ParameterContextEntity. + The permissions for this component. + + :param permissions: The permissions of this ParameterContextEntity. + :type: PermissionsDTO + """ + + self._permissions = permissions + + @property + def bulletins(self): + """ + Gets the bulletins of this ParameterContextEntity. + The bulletins for this component. + + :return: The bulletins of this ParameterContextEntity. + :rtype: list[BulletinEntity] + """ + return self._bulletins + + @bulletins.setter + def bulletins(self, bulletins): + """ + Sets the bulletins of this ParameterContextEntity. + The bulletins for this component. + + :param bulletins: The bulletins of this ParameterContextEntity. + :type: list[BulletinEntity] + """ + + self._bulletins = bulletins + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ParameterContextEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ParameterContextEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ParameterContextEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterContextEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def component(self): + """ + Gets the component of this ParameterContextEntity. + The Parameter Context + + :return: The component of this ParameterContextEntity. + :rtype: ParameterContextDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ParameterContextEntity. + The Parameter Context + + :param component: The component of this ParameterContextEntity. + :type: ParameterContextDTO + """ + + self._component = component + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_reference_dto.py b/nipyapi/nifi/models/parameter_context_reference_dto.py new file mode 100644 index 00000000..8d5a0733 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_reference_dto.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextReferenceDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'name': 'str' + } + + attribute_map = { + 'id': 'id', + 'name': 'name' + } + + def __init__(self, id=None, name=None): + """ + ParameterContextReferenceDTO - a model defined in Swagger + """ + + self._id = None + self._name = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + + @property + def id(self): + """ + Gets the id of this ParameterContextReferenceDTO. + The ID of the Parameter Context + + :return: The id of this ParameterContextReferenceDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextReferenceDTO. + The ID of the Parameter Context + + :param id: The id of this ParameterContextReferenceDTO. + :type: str + """ + + self._id = id + + @property + def name(self): + """ + Gets the name of this ParameterContextReferenceDTO. + The name of the Parameter Context + + :return: The name of this ParameterContextReferenceDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ParameterContextReferenceDTO. + The name of the Parameter Context + + :param name: The name of this ParameterContextReferenceDTO. + :type: str + """ + + self._name = name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextReferenceDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_reference_entity.py b/nipyapi/nifi/models/parameter_context_reference_entity.py new file mode 100644 index 00000000..d8ccf495 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_reference_entity.py @@ -0,0 +1,179 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextReferenceEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'permissions': 'PermissionsDTO', + 'component': 'ParameterContextReferenceDTO' + } + + attribute_map = { + 'id': 'id', + 'permissions': 'permissions', + 'component': 'component' + } + + def __init__(self, id=None, permissions=None, component=None): + """ + ParameterContextReferenceEntity - a model defined in Swagger + """ + + self._id = None + self._permissions = None + self._component = None + + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if component is not None: + self.component = component + + @property + def id(self): + """ + Gets the id of this ParameterContextReferenceEntity. + The id of the component. + + :return: The id of this ParameterContextReferenceEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextReferenceEntity. + The id of the component. + + :param id: The id of this ParameterContextReferenceEntity. + :type: str + """ + + self._id = id + + @property + def permissions(self): + """ + Gets the permissions of this ParameterContextReferenceEntity. + The permissions for this component. + + :return: The permissions of this ParameterContextReferenceEntity. + :rtype: PermissionsDTO + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ParameterContextReferenceEntity. + The permissions for this component. + + :param permissions: The permissions of this ParameterContextReferenceEntity. + :type: PermissionsDTO + """ + + self._permissions = permissions + + @property + def component(self): + """ + Gets the component of this ParameterContextReferenceEntity. + + :return: The component of this ParameterContextReferenceEntity. + :rtype: ParameterContextReferenceDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ParameterContextReferenceEntity. + + :param component: The component of this ParameterContextReferenceEntity. + :type: ParameterContextReferenceDTO + """ + + self._component = component + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextReferenceEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_update_request_dto.py b/nipyapi/nifi/models/parameter_context_update_request_dto.py new file mode 100644 index 00000000..d48faac7 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_update_request_dto.py @@ -0,0 +1,405 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextUpdateRequestDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'request_id': 'str', + 'uri': 'str', + 'submission_time': 'datetime', + 'last_updated': 'datetime', + 'complete': 'bool', + 'failure_reason': 'str', + 'percent_completed': 'int', + 'state': 'str', + 'update_steps': 'list[ParameterContextUpdateStepDTO]', + 'parameter_context': 'ParameterContextDTO', + 'referencing_components': 'list[AffectedComponentEntity]' + } + + attribute_map = { + 'request_id': 'requestId', + 'uri': 'uri', + 'submission_time': 'submissionTime', + 'last_updated': 'lastUpdated', + 'complete': 'complete', + 'failure_reason': 'failureReason', + 'percent_completed': 'percentCompleted', + 'state': 'state', + 'update_steps': 'updateSteps', + 'parameter_context': 'parameterContext', + 'referencing_components': 'referencingComponents' + } + + def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, parameter_context=None, referencing_components=None): + """ + ParameterContextUpdateRequestDTO - a model defined in Swagger + """ + + self._request_id = None + self._uri = None + self._submission_time = None + self._last_updated = None + self._complete = None + self._failure_reason = None + self._percent_completed = None + self._state = None + self._update_steps = None + self._parameter_context = None + self._referencing_components = None + + if request_id is not None: + self.request_id = request_id + if uri is not None: + self.uri = uri + if submission_time is not None: + self.submission_time = submission_time + if last_updated is not None: + self.last_updated = last_updated + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + if percent_completed is not None: + self.percent_completed = percent_completed + if state is not None: + self.state = state + if update_steps is not None: + self.update_steps = update_steps + if parameter_context is not None: + self.parameter_context = parameter_context + if referencing_components is not None: + self.referencing_components = referencing_components + + @property + def request_id(self): + """ + Gets the request_id of this ParameterContextUpdateRequestDTO. + The ID of the request + + :return: The request_id of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ParameterContextUpdateRequestDTO. + The ID of the request + + :param request_id: The request_id of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._request_id = request_id + + @property + def uri(self): + """ + Gets the uri of this ParameterContextUpdateRequestDTO. + The URI for the request + + :return: The uri of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ParameterContextUpdateRequestDTO. + The URI for the request + + :param uri: The uri of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._uri = uri + + @property + def submission_time(self): + """ + Gets the submission_time of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this ParameterContextUpdateRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this ParameterContextUpdateRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + + @property + def last_updated(self): + """ + Gets the last_updated of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was last updated + + :return: The last_updated of this ParameterContextUpdateRequestDTO. + :rtype: datetime + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """ + Sets the last_updated of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was last updated + + :param last_updated: The last_updated of this ParameterContextUpdateRequestDTO. + :type: datetime + """ + + self._last_updated = last_updated + + @property + def complete(self): + """ + Gets the complete of this ParameterContextUpdateRequestDTO. + Whether or not the request is completed + + :return: The complete of this ParameterContextUpdateRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextUpdateRequestDTO. + Whether or not the request is completed + + :param complete: The complete of this ParameterContextUpdateRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextUpdateRequestDTO. + The reason for the request failing, or null if the request has not failed + + :return: The failure_reason of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextUpdateRequestDTO. + The reason for the request failing, or null if the request has not failed + + :param failure_reason: The failure_reason of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def percent_completed(self): + """ + Gets the percent_completed of this ParameterContextUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this ParameterContextUpdateRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this ParameterContextUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this ParameterContextUpdateRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def state(self): + """ + Gets the state of this ParameterContextUpdateRequestDTO. + A description of the current state of the request + + :return: The state of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ParameterContextUpdateRequestDTO. + A description of the current state of the request + + :param state: The state of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._state = state + + @property + def update_steps(self): + """ + Gets the update_steps of this ParameterContextUpdateRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :return: The update_steps of this ParameterContextUpdateRequestDTO. + :rtype: list[ParameterContextUpdateStepDTO] + """ + return self._update_steps + + @update_steps.setter + def update_steps(self, update_steps): + """ + Sets the update_steps of this ParameterContextUpdateRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :param update_steps: The update_steps of this ParameterContextUpdateRequestDTO. + :type: list[ParameterContextUpdateStepDTO] + """ + + self._update_steps = update_steps + + @property + def parameter_context(self): + """ + Gets the parameter_context of this ParameterContextUpdateRequestDTO. + The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. + + :return: The parameter_context of this ParameterContextUpdateRequestDTO. + :rtype: ParameterContextDTO + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ParameterContextUpdateRequestDTO. + The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. + + :param parameter_context: The parameter_context of this ParameterContextUpdateRequestDTO. + :type: ParameterContextDTO + """ + + self._parameter_context = parameter_context + + @property + def referencing_components(self): + """ + Gets the referencing_components of this ParameterContextUpdateRequestDTO. + The components that are referenced by the update. + + :return: The referencing_components of this ParameterContextUpdateRequestDTO. + :rtype: list[AffectedComponentEntity] + """ + return self._referencing_components + + @referencing_components.setter + def referencing_components(self, referencing_components): + """ + Sets the referencing_components of this ParameterContextUpdateRequestDTO. + The components that are referenced by the update. + + :param referencing_components: The referencing_components of this ParameterContextUpdateRequestDTO. + :type: list[AffectedComponentEntity] + """ + + self._referencing_components = referencing_components + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextUpdateRequestDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_update_request_entity.py b/nipyapi/nifi/models/parameter_context_update_request_entity.py new file mode 100644 index 00000000..a980f1ac --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_update_request_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextUpdateRequestEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'parameter_context_revision': 'RevisionDTO', + 'request': 'ParameterContextUpdateRequestDTO' + } + + attribute_map = { + 'parameter_context_revision': 'parameterContextRevision', + 'request': 'request' + } + + def __init__(self, parameter_context_revision=None, request=None): + """ + ParameterContextUpdateRequestEntity - a model defined in Swagger + """ + + self._parameter_context_revision = None + self._request = None + + if parameter_context_revision is not None: + self.parameter_context_revision = parameter_context_revision + if request is not None: + self.request = request + + @property + def parameter_context_revision(self): + """ + Gets the parameter_context_revision of this ParameterContextUpdateRequestEntity. + The Revision of the Parameter Context + + :return: The parameter_context_revision of this ParameterContextUpdateRequestEntity. + :rtype: RevisionDTO + """ + return self._parameter_context_revision + + @parameter_context_revision.setter + def parameter_context_revision(self, parameter_context_revision): + """ + Sets the parameter_context_revision of this ParameterContextUpdateRequestEntity. + The Revision of the Parameter Context + + :param parameter_context_revision: The parameter_context_revision of this ParameterContextUpdateRequestEntity. + :type: RevisionDTO + """ + + self._parameter_context_revision = parameter_context_revision + + @property + def request(self): + """ + Gets the request of this ParameterContextUpdateRequestEntity. + The Update Request + + :return: The request of this ParameterContextUpdateRequestEntity. + :rtype: ParameterContextUpdateRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this ParameterContextUpdateRequestEntity. + The Update Request + + :param request: The request of this ParameterContextUpdateRequestEntity. + :type: ParameterContextUpdateRequestDTO + """ + + self._request = request + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextUpdateRequestEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_update_step_dto.py b/nipyapi/nifi/models/parameter_context_update_step_dto.py new file mode 100644 index 00000000..9ccc5f4a --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_update_step_dto.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextUpdateStepDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', + 'complete': 'bool', + 'failure_reason': 'str' + } + + attribute_map = { + 'description': 'description', + 'complete': 'complete', + 'failure_reason': 'failureReason' + } + + def __init__(self, description=None, complete=None, failure_reason=None): + """ + ParameterContextUpdateStepDTO - a model defined in Swagger + """ + + self._description = None + self._complete = None + self._failure_reason = None + + if description is not None: + self.description = description + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + + @property + def description(self): + """ + Gets the description of this ParameterContextUpdateStepDTO. + Explanation of what happens in this step + + :return: The description of this ParameterContextUpdateStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextUpdateStepDTO. + Explanation of what happens in this step + + :param description: The description of this ParameterContextUpdateStepDTO. + :type: str + """ + + self._description = description + + @property + def complete(self): + """ + Gets the complete of this ParameterContextUpdateStepDTO. + Whether or not this step has completed + + :return: The complete of this ParameterContextUpdateStepDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextUpdateStepDTO. + Whether or not this step has completed + + :param complete: The complete of this ParameterContextUpdateStepDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :return: The failure_reason of this ParameterContextUpdateStepDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :param failure_reason: The failure_reason of this ParameterContextUpdateStepDTO. + :type: str + """ + + self._failure_reason = failure_reason + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextUpdateStepDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_validation_request_dto.py b/nipyapi/nifi/models/parameter_context_validation_request_dto.py new file mode 100644 index 00000000..18dba560 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_validation_request_dto.py @@ -0,0 +1,405 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextValidationRequestDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'request_id': 'str', + 'uri': 'str', + 'submission_time': 'datetime', + 'last_updated': 'datetime', + 'complete': 'bool', + 'failure_reason': 'str', + 'percent_completed': 'int', + 'state': 'str', + 'update_steps': 'list[ParameterContextValidationStepDTO]', + 'parameter_context': 'ParameterContextDTO', + 'component_validation_results': 'ComponentValidationResultsEntity' + } + + attribute_map = { + 'request_id': 'requestId', + 'uri': 'uri', + 'submission_time': 'submissionTime', + 'last_updated': 'lastUpdated', + 'complete': 'complete', + 'failure_reason': 'failureReason', + 'percent_completed': 'percentCompleted', + 'state': 'state', + 'update_steps': 'updateSteps', + 'parameter_context': 'parameterContext', + 'component_validation_results': 'componentValidationResults' + } + + def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, parameter_context=None, component_validation_results=None): + """ + ParameterContextValidationRequestDTO - a model defined in Swagger + """ + + self._request_id = None + self._uri = None + self._submission_time = None + self._last_updated = None + self._complete = None + self._failure_reason = None + self._percent_completed = None + self._state = None + self._update_steps = None + self._parameter_context = None + self._component_validation_results = None + + if request_id is not None: + self.request_id = request_id + if uri is not None: + self.uri = uri + if submission_time is not None: + self.submission_time = submission_time + if last_updated is not None: + self.last_updated = last_updated + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + if percent_completed is not None: + self.percent_completed = percent_completed + if state is not None: + self.state = state + if update_steps is not None: + self.update_steps = update_steps + if parameter_context is not None: + self.parameter_context = parameter_context + if component_validation_results is not None: + self.component_validation_results = component_validation_results + + @property + def request_id(self): + """ + Gets the request_id of this ParameterContextValidationRequestDTO. + The ID of the request + + :return: The request_id of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ParameterContextValidationRequestDTO. + The ID of the request + + :param request_id: The request_id of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._request_id = request_id + + @property + def uri(self): + """ + Gets the uri of this ParameterContextValidationRequestDTO. + The URI for the request + + :return: The uri of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ParameterContextValidationRequestDTO. + The URI for the request + + :param uri: The uri of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._uri = uri + + @property + def submission_time(self): + """ + Gets the submission_time of this ParameterContextValidationRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this ParameterContextValidationRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ParameterContextValidationRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this ParameterContextValidationRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + + @property + def last_updated(self): + """ + Gets the last_updated of this ParameterContextValidationRequestDTO. + The timestamp of when the request was last updated + + :return: The last_updated of this ParameterContextValidationRequestDTO. + :rtype: datetime + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """ + Sets the last_updated of this ParameterContextValidationRequestDTO. + The timestamp of when the request was last updated + + :param last_updated: The last_updated of this ParameterContextValidationRequestDTO. + :type: datetime + """ + + self._last_updated = last_updated + + @property + def complete(self): + """ + Gets the complete of this ParameterContextValidationRequestDTO. + Whether or not the request is completed + + :return: The complete of this ParameterContextValidationRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextValidationRequestDTO. + Whether or not the request is completed + + :param complete: The complete of this ParameterContextValidationRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextValidationRequestDTO. + The reason for the request failing, or null if the request has not failed + + :return: The failure_reason of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextValidationRequestDTO. + The reason for the request failing, or null if the request has not failed + + :param failure_reason: The failure_reason of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def percent_completed(self): + """ + Gets the percent_completed of this ParameterContextValidationRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this ParameterContextValidationRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this ParameterContextValidationRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this ParameterContextValidationRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def state(self): + """ + Gets the state of this ParameterContextValidationRequestDTO. + A description of the current state of the request + + :return: The state of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ParameterContextValidationRequestDTO. + A description of the current state of the request + + :param state: The state of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._state = state + + @property + def update_steps(self): + """ + Gets the update_steps of this ParameterContextValidationRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :return: The update_steps of this ParameterContextValidationRequestDTO. + :rtype: list[ParameterContextValidationStepDTO] + """ + return self._update_steps + + @update_steps.setter + def update_steps(self, update_steps): + """ + Sets the update_steps of this ParameterContextValidationRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :param update_steps: The update_steps of this ParameterContextValidationRequestDTO. + :type: list[ParameterContextValidationStepDTO] + """ + + self._update_steps = update_steps + + @property + def parameter_context(self): + """ + Gets the parameter_context of this ParameterContextValidationRequestDTO. + The Parameter Context that is being operated on. + + :return: The parameter_context of this ParameterContextValidationRequestDTO. + :rtype: ParameterContextDTO + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ParameterContextValidationRequestDTO. + The Parameter Context that is being operated on. + + :param parameter_context: The parameter_context of this ParameterContextValidationRequestDTO. + :type: ParameterContextDTO + """ + + self._parameter_context = parameter_context + + @property + def component_validation_results(self): + """ + Gets the component_validation_results of this ParameterContextValidationRequestDTO. + The Validation Results that were calculated for each component. This value may not be set until the request completes. + + :return: The component_validation_results of this ParameterContextValidationRequestDTO. + :rtype: ComponentValidationResultsEntity + """ + return self._component_validation_results + + @component_validation_results.setter + def component_validation_results(self, component_validation_results): + """ + Sets the component_validation_results of this ParameterContextValidationRequestDTO. + The Validation Results that were calculated for each component. This value may not be set until the request completes. + + :param component_validation_results: The component_validation_results of this ParameterContextValidationRequestDTO. + :type: ComponentValidationResultsEntity + """ + + self._component_validation_results = component_validation_results + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextValidationRequestDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_validation_request_entity.py b/nipyapi/nifi/models/parameter_context_validation_request_entity.py new file mode 100644 index 00000000..cc35a2fb --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_validation_request_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextValidationRequestEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'request': 'ParameterContextValidationRequestDTO', + 'disconnected_node_acknowledged': 'bool' + } + + attribute_map = { + 'request': 'request', + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' + } + + def __init__(self, request=None, disconnected_node_acknowledged=None): + """ + ParameterContextValidationRequestEntity - a model defined in Swagger + """ + + self._request = None + self._disconnected_node_acknowledged = None + + if request is not None: + self.request = request + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def request(self): + """ + Gets the request of this ParameterContextValidationRequestEntity. + The Update Request + + :return: The request of this ParameterContextValidationRequestEntity. + :rtype: ParameterContextValidationRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this ParameterContextValidationRequestEntity. + The Update Request + + :param request: The request of this ParameterContextValidationRequestEntity. + :type: ParameterContextValidationRequestDTO + """ + + self._request = request + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextValidationRequestEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_validation_step_dto.py b/nipyapi/nifi/models/parameter_context_validation_step_dto.py new file mode 100644 index 00000000..82bb1b12 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_validation_step_dto.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextValidationStepDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', + 'complete': 'bool', + 'failure_reason': 'str' + } + + attribute_map = { + 'description': 'description', + 'complete': 'complete', + 'failure_reason': 'failureReason' + } + + def __init__(self, description=None, complete=None, failure_reason=None): + """ + ParameterContextValidationStepDTO - a model defined in Swagger + """ + + self._description = None + self._complete = None + self._failure_reason = None + + if description is not None: + self.description = description + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + + @property + def description(self): + """ + Gets the description of this ParameterContextValidationStepDTO. + Explanation of what happens in this step + + :return: The description of this ParameterContextValidationStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextValidationStepDTO. + Explanation of what happens in this step + + :param description: The description of this ParameterContextValidationStepDTO. + :type: str + """ + + self._description = description + + @property + def complete(self): + """ + Gets the complete of this ParameterContextValidationStepDTO. + Whether or not this step has completed + + :return: The complete of this ParameterContextValidationStepDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextValidationStepDTO. + Whether or not this step has completed + + :param complete: The complete of this ParameterContextValidationStepDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextValidationStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :return: The failure_reason of this ParameterContextValidationStepDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextValidationStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :param failure_reason: The failure_reason of this ParameterContextValidationStepDTO. + :type: str + """ + + self._failure_reason = failure_reason + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextValidationStepDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_contexts_entity.py b/nipyapi/nifi/models/parameter_contexts_entity.py new file mode 100644 index 00000000..f90bc94c --- /dev/null +++ b/nipyapi/nifi/models/parameter_contexts_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'parameter_contexts': 'list[ParameterContextEntity]', + 'current_time': 'str' + } + + attribute_map = { + 'parameter_contexts': 'parameterContexts', + 'current_time': 'currentTime' + } + + def __init__(self, parameter_contexts=None, current_time=None): + """ + ParameterContextsEntity - a model defined in Swagger + """ + + self._parameter_contexts = None + self._current_time = None + + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if current_time is not None: + self.current_time = current_time + + @property + def parameter_contexts(self): + """ + Gets the parameter_contexts of this ParameterContextsEntity. + The Parameter Contexts + + :return: The parameter_contexts of this ParameterContextsEntity. + :rtype: list[ParameterContextEntity] + """ + return self._parameter_contexts + + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): + """ + Sets the parameter_contexts of this ParameterContextsEntity. + The Parameter Contexts + + :param parameter_contexts: The parameter_contexts of this ParameterContextsEntity. + :type: list[ParameterContextEntity] + """ + + self._parameter_contexts = parameter_contexts + + @property + def current_time(self): + """ + Gets the current_time of this ParameterContextsEntity. + The current time on the system. + + :return: The current_time of this ParameterContextsEntity. + :rtype: str + """ + return self._current_time + + @current_time.setter + def current_time(self, current_time): + """ + Sets the current_time of this ParameterContextsEntity. + The current time on the system. + + :param current_time: The current_time of this ParameterContextsEntity. + :type: str + """ + + self._current_time = current_time + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_dto.py b/nipyapi/nifi/models/parameter_dto.py new file mode 100644 index 00000000..9ddc80d7 --- /dev/null +++ b/nipyapi/nifi/models/parameter_dto.py @@ -0,0 +1,237 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'sensitive': 'bool', + 'value': 'str', + 'referencing_components': 'list[AffectedComponentEntity]' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'sensitive': 'sensitive', + 'value': 'value', + 'referencing_components': 'referencingComponents' + } + + def __init__(self, name=None, description=None, sensitive=None, value=None, referencing_components=None): + """ + ParameterDTO - a model defined in Swagger + """ + + self._name = None + self._description = None + self._sensitive = None + self._value = None + self._referencing_components = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if sensitive is not None: + self.sensitive = sensitive + if value is not None: + self.value = value + if referencing_components is not None: + self.referencing_components = referencing_components + + @property + def name(self): + """ + Gets the name of this ParameterDTO. + The name of the Parameter + + :return: The name of this ParameterDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ParameterDTO. + The name of the Parameter + + :param name: The name of this ParameterDTO. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this ParameterDTO. + The description of the Parameter + + :return: The description of this ParameterDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterDTO. + The description of the Parameter + + :param description: The description of this ParameterDTO. + :type: str + """ + + self._description = description + + @property + def sensitive(self): + """ + Gets the sensitive of this ParameterDTO. + Whether or not the Parameter is sensitive + + :return: The sensitive of this ParameterDTO. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this ParameterDTO. + Whether or not the Parameter is sensitive + + :param sensitive: The sensitive of this ParameterDTO. + :type: bool + """ + + self._sensitive = sensitive + + @property + def value(self): + """ + Gets the value of this ParameterDTO. + The value of the Parameter + + :return: The value of this ParameterDTO. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ParameterDTO. + The value of the Parameter + + :param value: The value of this ParameterDTO. + :type: str + """ + + self._value = value + + @property + def referencing_components(self): + """ + Gets the referencing_components of this ParameterDTO. + The set of all components in the flow that are referencing this Parameter + + :return: The referencing_components of this ParameterDTO. + :rtype: list[AffectedComponentEntity] + """ + return self._referencing_components + + @referencing_components.setter + def referencing_components(self, referencing_components): + """ + Sets the referencing_components of this ParameterDTO. + The set of all components in the flow that are referencing this Parameter + + :param referencing_components: The referencing_components of this ParameterDTO. + :type: list[AffectedComponentEntity] + """ + + self._referencing_components = referencing_components + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_entity.py b/nipyapi/nifi/models/parameter_entity.py new file mode 100644 index 00000000..ca0bdc72 --- /dev/null +++ b/nipyapi/nifi/models/parameter_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'can_write': 'bool', + 'parameter': 'ParameterDTO' + } + + attribute_map = { + 'can_write': 'canWrite', + 'parameter': 'parameter' + } + + def __init__(self, can_write=None, parameter=None): + """ + ParameterEntity - a model defined in Swagger + """ + + self._can_write = None + self._parameter = None + + if can_write is not None: + self.can_write = can_write + if parameter is not None: + self.parameter = parameter + + @property + def can_write(self): + """ + Gets the can_write of this ParameterEntity. + Indicates whether the user can write a given resource. + + :return: The can_write of this ParameterEntity. + :rtype: bool + """ + return self._can_write + + @can_write.setter + def can_write(self, can_write): + """ + Sets the can_write of this ParameterEntity. + Indicates whether the user can write a given resource. + + :param can_write: The can_write of this ParameterEntity. + :type: bool + """ + + self._can_write = can_write + + @property + def parameter(self): + """ + Gets the parameter of this ParameterEntity. + The parameter information + + :return: The parameter of this ParameterEntity. + :rtype: ParameterDTO + """ + return self._parameter + + @parameter.setter + def parameter(self, parameter): + """ + Sets the parameter of this ParameterEntity. + The parameter information + + :param parameter: The parameter of this ParameterEntity. + :type: ParameterDTO + """ + + self._parameter = parameter + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/peer_dto.py b/nipyapi/nifi/models/peer_dto.py index c9b799e8..4125fc87 100644 --- a/nipyapi/nifi/models/peer_dto.py +++ b/nipyapi/nifi/models/peer_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peers_entity.py b/nipyapi/nifi/models/peers_entity.py index ed086803..b87f6a1f 100644 --- a/nipyapi/nifi/models/peers_entity.py +++ b/nipyapi/nifi/models/peers_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions.py b/nipyapi/nifi/models/permissions.py index 106a82bb..5b078121 100644 --- a/nipyapi/nifi/models/permissions.py +++ b/nipyapi/nifi/models/permissions.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions_dto.py b/nipyapi/nifi/models/permissions_dto.py index a270bf0f..eafa7e9d 100644 --- a/nipyapi/nifi/models/permissions_dto.py +++ b/nipyapi/nifi/models/permissions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_dto.py b/nipyapi/nifi/models/port_dto.py index 3f008910..9f2685a6 100644 --- a/nipyapi/nifi/models/port_dto.py +++ b/nipyapi/nifi/models/port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,6 +43,7 @@ class PortDTO(object): 'concurrently_schedulable_task_count': 'int', 'user_access_control': 'list[str]', 'group_access_control': 'list[str]', + 'allow_remote_access': 'bool', 'validation_errors': 'list[str]' } @@ -59,10 +60,11 @@ class PortDTO(object): 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'user_access_control': 'userAccessControl', 'group_access_control': 'groupAccessControl', + 'allow_remote_access': 'allowRemoteAccess', 'validation_errors': 'validationErrors' } - def __init__(self, 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, validation_errors=None): + def __init__(self, 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): """ PortDTO - a model defined in Swagger """ @@ -79,6 +81,7 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self._concurrently_schedulable_task_count = None self._user_access_control = None self._group_access_control = None + self._allow_remote_access = None self._validation_errors = None if id is not None: @@ -105,6 +108,8 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self.user_access_control = user_access_control if group_access_control is not None: self.group_access_control = group_access_control + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access if validation_errors is not None: self.validation_errors = validation_errors @@ -308,7 +313,7 @@ def type(self, type): def transmitting(self): """ 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 running in the root group. + 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. :return: The transmitting of this PortDTO. :rtype: bool @@ -319,7 +324,7 @@ def transmitting(self): def transmitting(self, transmitting): """ Sets 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 running in the root group. + 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. :param transmitting: The transmitting of this PortDTO. :type: bool @@ -396,6 +401,29 @@ def group_access_control(self, group_access_control): self._group_access_control = group_access_control + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this PortDTO. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :return: The allow_remote_access of this PortDTO. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this PortDTO. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :param allow_remote_access: The allow_remote_access of this PortDTO. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + @property def validation_errors(self): """ diff --git a/nipyapi/nifi/models/port_entity.py b/nipyapi/nifi/models/port_entity.py index 829065a2..af3b8d5b 100644 --- a/nipyapi/nifi/models/port_entity.py +++ b/nipyapi/nifi/models/port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,7 +41,8 @@ class PortEntity(object): 'component': 'PortDTO', 'status': 'PortStatusDTO', 'port_type': 'str', - 'operate_permissions': 'PermissionsDTO' + 'operate_permissions': 'PermissionsDTO', + 'allow_remote_access': 'bool' } attribute_map = { @@ -55,10 +56,11 @@ class PortEntity(object): 'component': 'component', 'status': 'status', 'port_type': 'portType', - 'operate_permissions': 'operatePermissions' + 'operate_permissions': 'operatePermissions', + 'allow_remote_access': 'allowRemoteAccess' } - def __init__(self, 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): + def __init__(self, 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): """ PortEntity - a model defined in Swagger """ @@ -74,6 +76,7 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self._status = None self._port_type = None self._operate_permissions = None + self._allow_remote_access = None if revision is not None: self.revision = revision @@ -97,6 +100,8 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self.port_type = port_type if operate_permissions is not None: self.operate_permissions = operate_permissions + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access @property def revision(self): @@ -347,6 +352,29 @@ def operate_permissions(self, operate_permissions): self._operate_permissions = operate_permissions + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this PortEntity. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :return: The allow_remote_access of this PortEntity. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this PortEntity. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :param allow_remote_access: The allow_remote_access of this PortEntity. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/port_run_status_entity.py b/nipyapi/nifi/models/port_run_status_entity.py index 5dc0503e..efdc6040 100644 --- a/nipyapi/nifi/models/port_run_status_entity.py +++ b/nipyapi/nifi/models/port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_dto.py b/nipyapi/nifi/models/port_status_dto.py index 465c7bec..92a0d5e0 100644 --- a/nipyapi/nifi/models/port_status_dto.py +++ b/nipyapi/nifi/models/port_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_entity.py b/nipyapi/nifi/models/port_status_entity.py index c28397df..adc7c9f2 100644 --- a/nipyapi/nifi/models/port_status_entity.py +++ b/nipyapi/nifi/models/port_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_dto.py b/nipyapi/nifi/models/port_status_snapshot_dto.py index 0486da38..f9e9aea5 100644 --- a/nipyapi/nifi/models/port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_entity.py b/nipyapi/nifi/models/port_status_snapshot_entity.py index d502ee9f..c021e925 100644 --- a/nipyapi/nifi/models/port_status_snapshot_entity.py +++ b/nipyapi/nifi/models/port_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position.py b/nipyapi/nifi/models/position.py index 84a30516..c6ae7b92 100644 --- a/nipyapi/nifi/models/position.py +++ b/nipyapi/nifi/models/position.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position_dto.py b/nipyapi/nifi/models/position_dto.py index 0f9d6d34..b7a1ffb1 100644 --- a/nipyapi/nifi/models/position_dto.py +++ b/nipyapi/nifi/models/position_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/previous_value_dto.py b/nipyapi/nifi/models/previous_value_dto.py index 2d7df501..ae46d106 100644 --- a/nipyapi/nifi/models/previous_value_dto.py +++ b/nipyapi/nifi/models/previous_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/prioritizer_types_entity.py b/nipyapi/nifi/models/prioritizer_types_entity.py index 77d044a8..9ddbea7b 100644 --- a/nipyapi/nifi/models/prioritizer_types_entity.py +++ b/nipyapi/nifi/models/prioritizer_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_dto.py b/nipyapi/nifi/models/process_group_dto.py index 3f45c07b..58745f54 100644 --- a/nipyapi/nifi/models/process_group_dto.py +++ b/nipyapi/nifi/models/process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -39,6 +39,7 @@ class ProcessGroupDTO(object): 'comments': 'str', 'variables': 'dict(str, str)', 'version_control_information': 'VersionControlInformationDTO', + 'parameter_context': 'ParameterContextReferenceEntity', 'running_count': 'int', 'stopped_count': 'int', 'invalid_count': 'int', @@ -50,9 +51,13 @@ class ProcessGroupDTO(object): 'stale_count': 'int', 'locally_modified_and_stale_count': 'int', 'sync_failure_count': 'int', + 'local_input_port_count': 'int', + 'local_output_port_count': 'int', + 'public_input_port_count': 'int', + 'public_output_port_count': 'int', + 'contents': 'FlowSnippetDTO', 'input_port_count': 'int', - 'output_port_count': 'int', - 'contents': 'FlowSnippetDTO' + 'output_port_count': 'int' } attribute_map = { @@ -64,6 +69,7 @@ class ProcessGroupDTO(object): 'comments': 'comments', 'variables': 'variables', 'version_control_information': 'versionControlInformation', + 'parameter_context': 'parameterContext', 'running_count': 'runningCount', 'stopped_count': 'stoppedCount', 'invalid_count': 'invalidCount', @@ -75,12 +81,16 @@ class ProcessGroupDTO(object): 'stale_count': 'staleCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'sync_failure_count': 'syncFailureCount', + 'local_input_port_count': 'localInputPortCount', + 'local_output_port_count': 'localOutputPortCount', + 'public_input_port_count': 'publicInputPortCount', + 'public_output_port_count': 'publicOutputPortCount', + 'contents': 'contents', 'input_port_count': 'inputPortCount', - 'output_port_count': 'outputPortCount', - 'contents': 'contents' + 'output_port_count': 'outputPortCount' } - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, variables=None, version_control_information=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, input_port_count=None, output_port_count=None, contents=None): + def __init__(self, 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, 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): """ ProcessGroupDTO - a model defined in Swagger """ @@ -93,6 +103,7 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self._comments = None self._variables = None self._version_control_information = None + self._parameter_context = None self._running_count = None self._stopped_count = None self._invalid_count = None @@ -104,9 +115,13 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self._stale_count = None self._locally_modified_and_stale_count = None self._sync_failure_count = None + self._local_input_port_count = None + self._local_output_port_count = None + self._public_input_port_count = None + self._public_output_port_count = None + self._contents = None self._input_port_count = None self._output_port_count = None - self._contents = None if id is not None: self.id = id @@ -124,6 +139,8 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self.variables = variables if version_control_information is not None: self.version_control_information = version_control_information + if parameter_context is not None: + self.parameter_context = parameter_context if running_count is not None: self.running_count = running_count if stopped_count is not None: @@ -146,12 +163,20 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self.locally_modified_and_stale_count = locally_modified_and_stale_count if sync_failure_count is not None: self.sync_failure_count = sync_failure_count + if local_input_port_count is not None: + self.local_input_port_count = local_input_port_count + if local_output_port_count is not None: + self.local_output_port_count = local_output_port_count + if public_input_port_count is not None: + self.public_input_port_count = public_input_port_count + if public_output_port_count is not None: + self.public_output_port_count = public_output_port_count + if contents is not None: + self.contents = contents if input_port_count is not None: self.input_port_count = input_port_count if output_port_count is not None: self.output_port_count = output_port_count - if contents is not None: - self.contents = contents @property def id(self): @@ -337,6 +362,29 @@ def version_control_information(self, version_control_information): self._version_control_information = version_control_information + @property + def parameter_context(self): + """ + Gets the parameter_context of this ProcessGroupDTO. + The Parameter Context that this Process Group is bound to. + + :return: The parameter_context of this ProcessGroupDTO. + :rtype: ParameterContextReferenceEntity + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ProcessGroupDTO. + The Parameter Context that this Process Group is bound to. + + :param parameter_context: The parameter_context of this ProcessGroupDTO. + :type: ParameterContextReferenceEntity + """ + + self._parameter_context = parameter_context + @property def running_count(self): """ @@ -591,50 +639,96 @@ def sync_failure_count(self, sync_failure_count): self._sync_failure_count = sync_failure_count @property - def input_port_count(self): + def local_input_port_count(self): """ - Gets the input_port_count of this ProcessGroupDTO. - The number of input ports in the process group. + Gets the local_input_port_count of this ProcessGroupDTO. + The number of local input ports in the process group. - :return: The input_port_count of this ProcessGroupDTO. + :return: The local_input_port_count of this ProcessGroupDTO. :rtype: int """ - return self._input_port_count + return self._local_input_port_count - @input_port_count.setter - def input_port_count(self, input_port_count): + @local_input_port_count.setter + def local_input_port_count(self, local_input_port_count): """ - Sets the input_port_count of this ProcessGroupDTO. - The number of input ports in the process group. + Sets the local_input_port_count of this ProcessGroupDTO. + The number of local input ports in the process group. - :param input_port_count: The input_port_count of this ProcessGroupDTO. + :param local_input_port_count: The local_input_port_count of this ProcessGroupDTO. :type: int """ - self._input_port_count = input_port_count + self._local_input_port_count = local_input_port_count @property - def output_port_count(self): + def local_output_port_count(self): """ - Gets the output_port_count of this ProcessGroupDTO. - The number of output ports in the process group. + Gets the local_output_port_count of this ProcessGroupDTO. + The number of local output ports in the process group. - :return: The output_port_count of this ProcessGroupDTO. + :return: The local_output_port_count of this ProcessGroupDTO. :rtype: int """ - return self._output_port_count + return self._local_output_port_count - @output_port_count.setter - def output_port_count(self, output_port_count): + @local_output_port_count.setter + def local_output_port_count(self, local_output_port_count): """ - Sets the output_port_count of this ProcessGroupDTO. - The number of output ports in the process group. + Sets the local_output_port_count of this ProcessGroupDTO. + The number of local output ports in the process group. - :param output_port_count: The output_port_count of this ProcessGroupDTO. + :param local_output_port_count: The local_output_port_count of this ProcessGroupDTO. :type: int """ - self._output_port_count = output_port_count + self._local_output_port_count = local_output_port_count + + @property + def public_input_port_count(self): + """ + Gets the public_input_port_count of this ProcessGroupDTO. + The number of public input ports in the process group. + + :return: The public_input_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._public_input_port_count + + @public_input_port_count.setter + def public_input_port_count(self, public_input_port_count): + """ + Sets the public_input_port_count of this ProcessGroupDTO. + The number of public input ports in the process group. + + :param public_input_port_count: The public_input_port_count of this ProcessGroupDTO. + :type: int + """ + + self._public_input_port_count = public_input_port_count + + @property + def public_output_port_count(self): + """ + Gets the public_output_port_count of this ProcessGroupDTO. + The number of public output ports in the process group. + + :return: The public_output_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._public_output_port_count + + @public_output_port_count.setter + def public_output_port_count(self, public_output_port_count): + """ + Sets the public_output_port_count of this ProcessGroupDTO. + The number of public output ports in the process group. + + :param public_output_port_count: The public_output_port_count of this ProcessGroupDTO. + :type: int + """ + + self._public_output_port_count = public_output_port_count @property def contents(self): @@ -659,6 +753,52 @@ def contents(self, contents): self._contents = contents + @property + def input_port_count(self): + """ + Gets the input_port_count of this ProcessGroupDTO. + The number of input ports in the process group. + + :return: The input_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._input_port_count + + @input_port_count.setter + def input_port_count(self, input_port_count): + """ + Sets the input_port_count of this ProcessGroupDTO. + The number of input ports in the process group. + + :param input_port_count: The input_port_count of this ProcessGroupDTO. + :type: int + """ + + self._input_port_count = input_port_count + + @property + def output_port_count(self): + """ + Gets the output_port_count of this ProcessGroupDTO. + The number of output ports in the process group. + + :return: The output_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._output_port_count + + @output_port_count.setter + def output_port_count(self, output_port_count): + """ + Sets the output_port_count of this ProcessGroupDTO. + The number of output ports in the process group. + + :param output_port_count: The output_port_count of this ProcessGroupDTO. + :type: int + """ + + self._output_port_count = output_port_count + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/process_group_entity.py b/nipyapi/nifi/models/process_group_entity.py index 1ca196e0..7de62677 100644 --- a/nipyapi/nifi/models/process_group_entity.py +++ b/nipyapi/nifi/models/process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -53,6 +53,11 @@ class ProcessGroupEntity(object): 'stale_count': 'int', 'locally_modified_and_stale_count': 'int', 'sync_failure_count': 'int', + 'local_input_port_count': 'int', + 'local_output_port_count': 'int', + 'public_input_port_count': 'int', + 'public_output_port_count': 'int', + 'parameter_context': 'ParameterContextReferenceEntity', 'input_port_count': 'int', 'output_port_count': 'int' } @@ -80,11 +85,16 @@ class ProcessGroupEntity(object): 'stale_count': 'staleCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'sync_failure_count': 'syncFailureCount', + 'local_input_port_count': 'localInputPortCount', + 'local_output_port_count': 'localOutputPortCount', + 'public_input_port_count': 'publicInputPortCount', + 'public_output_port_count': 'publicOutputPortCount', + 'parameter_context': 'parameterContext', 'input_port_count': 'inputPortCount', 'output_port_count': 'outputPortCount' } - def __init__(self, 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, input_port_count=None, output_port_count=None): + def __init__(self, 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): """ ProcessGroupEntity - a model defined in Swagger """ @@ -111,6 +121,11 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self._stale_count = None self._locally_modified_and_stale_count = None self._sync_failure_count = None + self._local_input_port_count = None + self._local_output_port_count = None + self._public_input_port_count = None + self._public_output_port_count = None + self._parameter_context = None self._input_port_count = None self._output_port_count = None @@ -158,6 +173,16 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self.locally_modified_and_stale_count = locally_modified_and_stale_count if sync_failure_count is not None: self.sync_failure_count = sync_failure_count + if local_input_port_count is not None: + self.local_input_port_count = local_input_port_count + if local_output_port_count is not None: + self.local_output_port_count = local_output_port_count + if public_input_port_count is not None: + self.public_input_port_count = public_input_port_count + if public_output_port_count is not None: + self.public_output_port_count = public_output_port_count + if parameter_context is not None: + self.parameter_context = parameter_context if input_port_count is not None: self.input_port_count = input_port_count if output_port_count is not None: @@ -673,6 +698,121 @@ def sync_failure_count(self, sync_failure_count): self._sync_failure_count = sync_failure_count + @property + def local_input_port_count(self): + """ + Gets the local_input_port_count of this ProcessGroupEntity. + The number of local input ports in the process group. + + :return: The local_input_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._local_input_port_count + + @local_input_port_count.setter + def local_input_port_count(self, local_input_port_count): + """ + Sets the local_input_port_count of this ProcessGroupEntity. + The number of local input ports in the process group. + + :param local_input_port_count: The local_input_port_count of this ProcessGroupEntity. + :type: int + """ + + self._local_input_port_count = local_input_port_count + + @property + def local_output_port_count(self): + """ + Gets the local_output_port_count of this ProcessGroupEntity. + The number of local output ports in the process group. + + :return: The local_output_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._local_output_port_count + + @local_output_port_count.setter + def local_output_port_count(self, local_output_port_count): + """ + Sets the local_output_port_count of this ProcessGroupEntity. + The number of local output ports in the process group. + + :param local_output_port_count: The local_output_port_count of this ProcessGroupEntity. + :type: int + """ + + self._local_output_port_count = local_output_port_count + + @property + def public_input_port_count(self): + """ + Gets the public_input_port_count of this ProcessGroupEntity. + The number of public input ports in the process group. + + :return: The public_input_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._public_input_port_count + + @public_input_port_count.setter + def public_input_port_count(self, public_input_port_count): + """ + Sets the public_input_port_count of this ProcessGroupEntity. + The number of public input ports in the process group. + + :param public_input_port_count: The public_input_port_count of this ProcessGroupEntity. + :type: int + """ + + self._public_input_port_count = public_input_port_count + + @property + def public_output_port_count(self): + """ + Gets the public_output_port_count of this ProcessGroupEntity. + The number of public output ports in the process group. + + :return: The public_output_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._public_output_port_count + + @public_output_port_count.setter + def public_output_port_count(self, public_output_port_count): + """ + Sets the public_output_port_count of this ProcessGroupEntity. + The number of public output ports in the process group. + + :param public_output_port_count: The public_output_port_count of this ProcessGroupEntity. + :type: int + """ + + self._public_output_port_count = public_output_port_count + + @property + def parameter_context(self): + """ + Gets the parameter_context of this ProcessGroupEntity. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :return: The parameter_context of this ProcessGroupEntity. + :rtype: ParameterContextReferenceEntity + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ProcessGroupEntity. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :param parameter_context: The parameter_context of this ProcessGroupEntity. + :type: ParameterContextReferenceEntity + """ + + self._parameter_context = parameter_context + @property def input_port_count(self): """ diff --git a/nipyapi/nifi/models/process_group_flow_dto.py b/nipyapi/nifi/models/process_group_flow_dto.py index f38e46a9..d99ae92a 100644 --- a/nipyapi/nifi/models/process_group_flow_dto.py +++ b/nipyapi/nifi/models/process_group_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -34,6 +34,7 @@ class ProcessGroupFlowDTO(object): 'id': 'str', 'uri': 'str', 'parent_group_id': 'str', + 'parameter_context': 'ParameterContextReferenceEntity', 'breadcrumb': 'FlowBreadcrumbEntity', 'flow': 'FlowDTO', 'last_refreshed': 'str' @@ -43,12 +44,13 @@ class ProcessGroupFlowDTO(object): 'id': 'id', 'uri': 'uri', 'parent_group_id': 'parentGroupId', + 'parameter_context': 'parameterContext', 'breadcrumb': 'breadcrumb', 'flow': 'flow', 'last_refreshed': 'lastRefreshed' } - def __init__(self, id=None, uri=None, parent_group_id=None, breadcrumb=None, flow=None, last_refreshed=None): + def __init__(self, id=None, uri=None, parent_group_id=None, parameter_context=None, breadcrumb=None, flow=None, last_refreshed=None): """ ProcessGroupFlowDTO - a model defined in Swagger """ @@ -56,6 +58,7 @@ def __init__(self, id=None, uri=None, parent_group_id=None, breadcrumb=None, flo self._id = None self._uri = None self._parent_group_id = None + self._parameter_context = None self._breadcrumb = None self._flow = None self._last_refreshed = None @@ -66,6 +69,8 @@ def __init__(self, id=None, uri=None, parent_group_id=None, breadcrumb=None, flo self.uri = uri if parent_group_id is not None: self.parent_group_id = parent_group_id + if parameter_context is not None: + self.parameter_context = parameter_context if breadcrumb is not None: self.breadcrumb = breadcrumb if flow is not None: @@ -142,6 +147,29 @@ def parent_group_id(self, parent_group_id): self._parent_group_id = parent_group_id + @property + def parameter_context(self): + """ + Gets the parameter_context of this ProcessGroupFlowDTO. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :return: The parameter_context of this ProcessGroupFlowDTO. + :rtype: ParameterContextReferenceEntity + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ProcessGroupFlowDTO. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :param parameter_context: The parameter_context of this ProcessGroupFlowDTO. + :type: ParameterContextReferenceEntity + """ + + self._parameter_context = parameter_context + @property def breadcrumb(self): """ diff --git a/nipyapi/nifi/models/process_group_flow_entity.py b/nipyapi/nifi/models/process_group_flow_entity.py index 242ef005..20c8be40 100644 --- a/nipyapi/nifi/models/process_group_flow_entity.py +++ b/nipyapi/nifi/models/process_group_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_name_dto.py b/nipyapi/nifi/models/process_group_name_dto.py new file mode 100644 index 00000000..769f3757 --- /dev/null +++ b/nipyapi/nifi/models/process_group_name_dto.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessGroupNameDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'name': 'str' + } + + attribute_map = { + 'id': 'id', + 'name': 'name' + } + + def __init__(self, id=None, name=None): + """ + ProcessGroupNameDTO - a model defined in Swagger + """ + + self._id = None + self._name = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + + @property + def id(self): + """ + Gets the id of this ProcessGroupNameDTO. + The ID of the Process Group + + :return: The id of this ProcessGroupNameDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ProcessGroupNameDTO. + The ID of the Process Group + + :param id: The id of this ProcessGroupNameDTO. + :type: str + """ + + self._id = id + + @property + def name(self): + """ + Gets the name of this ProcessGroupNameDTO. + The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group + + :return: The name of this ProcessGroupNameDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ProcessGroupNameDTO. + The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group + + :param name: The name of this ProcessGroupNameDTO. + :type: str + """ + + self._name = name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessGroupNameDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/process_group_status_dto.py b/nipyapi/nifi/models/process_group_status_dto.py index 99030b88..df51175a 100644 --- a/nipyapi/nifi/models/process_group_status_dto.py +++ b/nipyapi/nifi/models/process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_entity.py b/nipyapi/nifi/models/process_group_status_entity.py index ea6e0fde..f46e4de3 100644 --- a/nipyapi/nifi/models/process_group_status_entity.py +++ b/nipyapi/nifi/models/process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_dto.py b/nipyapi/nifi/models/process_group_status_snapshot_dto.py index 7b2426a1..844e6e2e 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_entity.py b/nipyapi/nifi/models/process_group_status_snapshot_entity.py index 56343962..06099445 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_groups_entity.py b/nipyapi/nifi/models/process_groups_entity.py index 40ed2b64..f542f916 100644 --- a/nipyapi/nifi/models/process_groups_entity.py +++ b/nipyapi/nifi/models/process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_config_dto.py b/nipyapi/nifi/models/processor_config_dto.py index 751525ec..aac75c74 100644 --- a/nipyapi/nifi/models/processor_config_dto.py +++ b/nipyapi/nifi/models/processor_config_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_dto.py b/nipyapi/nifi/models/processor_dto.py index 66f41b2f..22288d8a 100644 --- a/nipyapi/nifi/models/processor_dto.py +++ b/nipyapi/nifi/models/processor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_entity.py b/nipyapi/nifi/models/processor_entity.py index 63f006f6..5abf2de7 100644 --- a/nipyapi/nifi/models/processor_entity.py +++ b/nipyapi/nifi/models/processor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_run_status_entity.py b/nipyapi/nifi/models/processor_run_status_entity.py index 3ecdb580..d9d5f0e1 100644 --- a/nipyapi/nifi/models/processor_run_status_entity.py +++ b/nipyapi/nifi/models/processor_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_dto.py b/nipyapi/nifi/models/processor_status_dto.py index aecbf667..19b8049d 100644 --- a/nipyapi/nifi/models/processor_status_dto.py +++ b/nipyapi/nifi/models/processor_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_entity.py b/nipyapi/nifi/models/processor_status_entity.py index 9275597e..9a38953f 100644 --- a/nipyapi/nifi/models/processor_status_entity.py +++ b/nipyapi/nifi/models/processor_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_dto.py b/nipyapi/nifi/models/processor_status_snapshot_dto.py index c472297e..5488e91e 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_entity.py b/nipyapi/nifi/models/processor_status_snapshot_entity.py index a1aabe47..fe7c0ce4 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_entity.py +++ b/nipyapi/nifi/models/processor_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_types_entity.py b/nipyapi/nifi/models/processor_types_entity.py index b888333a..2a29682f 100644 --- a/nipyapi/nifi/models/processor_types_entity.py +++ b/nipyapi/nifi/models/processor_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processors_entity.py b/nipyapi/nifi/models/processors_entity.py index 2ce65c23..1f38a11a 100644 --- a/nipyapi/nifi/models/processors_entity.py +++ b/nipyapi/nifi/models/processors_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_dto.py b/nipyapi/nifi/models/property_descriptor_dto.py index b421ba7b..75c7a2a0 100644 --- a/nipyapi/nifi/models/property_descriptor_dto.py +++ b/nipyapi/nifi/models/property_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_entity.py b/nipyapi/nifi/models/property_descriptor_entity.py index 00b1d9b5..8feb21ba 100644 --- a/nipyapi/nifi/models/property_descriptor_entity.py +++ b/nipyapi/nifi/models/property_descriptor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_history_dto.py b/nipyapi/nifi/models/property_history_dto.py index efe9553d..452bc4aa 100644 --- a/nipyapi/nifi/models/property_history_dto.py +++ b/nipyapi/nifi/models/property_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_dto.py b/nipyapi/nifi/models/provenance_dto.py index 758d824f..d2b54322 100644 --- a/nipyapi/nifi/models/provenance_dto.py +++ b/nipyapi/nifi/models/provenance_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_entity.py b/nipyapi/nifi/models/provenance_entity.py index e8adbce0..3452a681 100644 --- a/nipyapi/nifi/models/provenance_entity.py +++ b/nipyapi/nifi/models/provenance_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_dto.py b/nipyapi/nifi/models/provenance_event_dto.py index d588ed0a..11f7c112 100644 --- a/nipyapi/nifi/models/provenance_event_dto.py +++ b/nipyapi/nifi/models/provenance_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_entity.py b/nipyapi/nifi/models/provenance_event_entity.py index 8f66312b..5f077a8f 100644 --- a/nipyapi/nifi/models/provenance_event_entity.py +++ b/nipyapi/nifi/models/provenance_event_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_link_dto.py b/nipyapi/nifi/models/provenance_link_dto.py index 95b80b5f..1d6e1b1d 100644 --- a/nipyapi/nifi/models/provenance_link_dto.py +++ b/nipyapi/nifi/models/provenance_link_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_node_dto.py b/nipyapi/nifi/models/provenance_node_dto.py index c5b8263a..c10f1690 100644 --- a/nipyapi/nifi/models/provenance_node_dto.py +++ b/nipyapi/nifi/models/provenance_node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_dto.py b/nipyapi/nifi/models/provenance_options_dto.py index f106c308..61960d32 100644 --- a/nipyapi/nifi/models/provenance_options_dto.py +++ b/nipyapi/nifi/models/provenance_options_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_entity.py b/nipyapi/nifi/models/provenance_options_entity.py index 92b0db44..11515a72 100644 --- a/nipyapi/nifi/models/provenance_options_entity.py +++ b/nipyapi/nifi/models/provenance_options_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_request_dto.py b/nipyapi/nifi/models/provenance_request_dto.py index 7c845915..7c89f8f4 100644 --- a/nipyapi/nifi/models/provenance_request_dto.py +++ b/nipyapi/nifi/models/provenance_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_results_dto.py b/nipyapi/nifi/models/provenance_results_dto.py index e00a43c3..4c149b9c 100644 --- a/nipyapi/nifi/models/provenance_results_dto.py +++ b/nipyapi/nifi/models/provenance_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_searchable_field_dto.py b/nipyapi/nifi/models/provenance_searchable_field_dto.py index 4e551026..bf004b3c 100644 --- a/nipyapi/nifi/models/provenance_searchable_field_dto.py +++ b/nipyapi/nifi/models/provenance_searchable_field_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/queue_size_dto.py b/nipyapi/nifi/models/queue_size_dto.py index d94614cf..22e28a13 100644 --- a/nipyapi/nifi/models/queue_size_dto.py +++ b/nipyapi/nifi/models/queue_size_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_client_entity.py b/nipyapi/nifi/models/registry_client_entity.py index 854cd991..7988a9ef 100644 --- a/nipyapi/nifi/models/registry_client_entity.py +++ b/nipyapi/nifi/models/registry_client_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_clients_entity.py b/nipyapi/nifi/models/registry_clients_entity.py index 63ddbcb9..b2172920 100644 --- a/nipyapi/nifi/models/registry_clients_entity.py +++ b/nipyapi/nifi/models/registry_clients_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_dto.py b/nipyapi/nifi/models/registry_dto.py index 578c4acc..860a8856 100644 --- a/nipyapi/nifi/models/registry_dto.py +++ b/nipyapi/nifi/models/registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/relationship_dto.py b/nipyapi/nifi/models/relationship_dto.py index 540b5709..be415f73 100644 --- a/nipyapi/nifi/models/relationship_dto.py +++ b/nipyapi/nifi/models/relationship_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_port_run_status_entity.py b/nipyapi/nifi/models/remote_port_run_status_entity.py index 663f5c55..846ae1ce 100644 --- a/nipyapi/nifi/models/remote_port_run_status_entity.py +++ b/nipyapi/nifi/models/remote_port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_contents_dto.py b/nipyapi/nifi/models/remote_process_group_contents_dto.py index 451f2caf..cab77a69 100644 --- a/nipyapi/nifi/models/remote_process_group_contents_dto.py +++ b/nipyapi/nifi/models/remote_process_group_contents_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_dto.py b/nipyapi/nifi/models/remote_process_group_dto.py index 087d3a68..bf48de30 100644 --- a/nipyapi/nifi/models/remote_process_group_dto.py +++ b/nipyapi/nifi/models/remote_process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_entity.py b/nipyapi/nifi/models/remote_process_group_entity.py index 89327053..b4051cd5 100644 --- a/nipyapi/nifi/models/remote_process_group_entity.py +++ b/nipyapi/nifi/models/remote_process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_dto.py b/nipyapi/nifi/models/remote_process_group_port_dto.py index 43417832..f7c44aa0 100644 --- a/nipyapi/nifi/models/remote_process_group_port_dto.py +++ b/nipyapi/nifi/models/remote_process_group_port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_entity.py b/nipyapi/nifi/models/remote_process_group_port_entity.py index 35a1187a..f8e0bb2a 100644 --- a/nipyapi/nifi/models/remote_process_group_port_entity.py +++ b/nipyapi/nifi/models/remote_process_group_port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_dto.py b/nipyapi/nifi/models/remote_process_group_status_dto.py index f1cb019e..c44e041c 100644 --- a/nipyapi/nifi/models/remote_process_group_status_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_entity.py b/nipyapi/nifi/models/remote_process_group_status_entity.py index 711cb199..5052574f 100644 --- a/nipyapi/nifi/models/remote_process_group_status_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py index 3cc97e54..28a75c28 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py index 41462df8..f69636eb 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_groups_entity.py b/nipyapi/nifi/models/remote_process_groups_entity.py index 66cbe3c7..cecd9aba 100644 --- a/nipyapi/nifi/models/remote_process_groups_entity.py +++ b/nipyapi/nifi/models/remote_process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_dto.py b/nipyapi/nifi/models/reporting_task_dto.py index 5b19ac00..d5a8a7a2 100644 --- a/nipyapi/nifi/models/reporting_task_dto.py +++ b/nipyapi/nifi/models/reporting_task_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_entity.py b/nipyapi/nifi/models/reporting_task_entity.py index f5497e47..78bb3e20 100644 --- a/nipyapi/nifi/models/reporting_task_entity.py +++ b/nipyapi/nifi/models/reporting_task_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_run_status_entity.py b/nipyapi/nifi/models/reporting_task_run_status_entity.py index 83ffbe88..82d4b7a5 100644 --- a/nipyapi/nifi/models/reporting_task_run_status_entity.py +++ b/nipyapi/nifi/models/reporting_task_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_status_dto.py b/nipyapi/nifi/models/reporting_task_status_dto.py index 664d182e..f65964c5 100644 --- a/nipyapi/nifi/models/reporting_task_status_dto.py +++ b/nipyapi/nifi/models/reporting_task_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_types_entity.py b/nipyapi/nifi/models/reporting_task_types_entity.py index 0e8d295e..58f71da0 100644 --- a/nipyapi/nifi/models/reporting_task_types_entity.py +++ b/nipyapi/nifi/models/reporting_task_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_tasks_entity.py b/nipyapi/nifi/models/reporting_tasks_entity.py index af2692a2..bc39d9a6 100644 --- a/nipyapi/nifi/models/reporting_tasks_entity.py +++ b/nipyapi/nifi/models/reporting_tasks_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/required_permission_dto.py b/nipyapi/nifi/models/required_permission_dto.py index 0597830a..55ce5a03 100644 --- a/nipyapi/nifi/models/required_permission_dto.py +++ b/nipyapi/nifi/models/required_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resource_dto.py b/nipyapi/nifi/models/resource_dto.py index 8e84c99f..9a37354d 100644 --- a/nipyapi/nifi/models/resource_dto.py +++ b/nipyapi/nifi/models/resource_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resources_entity.py b/nipyapi/nifi/models/resources_entity.py index 9af4dc8d..cf0444cd 100644 --- a/nipyapi/nifi/models/resources_entity.py +++ b/nipyapi/nifi/models/resources_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/revision_dto.py b/nipyapi/nifi/models/revision_dto.py index 6306eca9..584d4baa 100644 --- a/nipyapi/nifi/models/revision_dto.py +++ b/nipyapi/nifi/models/revision_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/schedule_components_entity.py b/nipyapi/nifi/models/schedule_components_entity.py index 51bcd6b0..2c19bec1 100644 --- a/nipyapi/nifi/models/schedule_components_entity.py +++ b/nipyapi/nifi/models/schedule_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_result_group_dto.py b/nipyapi/nifi/models/search_result_group_dto.py index 54582f82..0fd323cb 100644 --- a/nipyapi/nifi/models/search_result_group_dto.py +++ b/nipyapi/nifi/models/search_result_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_results_dto.py b/nipyapi/nifi/models/search_results_dto.py index 214761ab..088fc9b9 100644 --- a/nipyapi/nifi/models/search_results_dto.py +++ b/nipyapi/nifi/models/search_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -37,7 +37,9 @@ class SearchResultsDTO(object): 'input_port_results': 'list[ComponentSearchResultDTO]', 'output_port_results': 'list[ComponentSearchResultDTO]', 'remote_process_group_results': 'list[ComponentSearchResultDTO]', - 'funnel_results': 'list[ComponentSearchResultDTO]' + 'funnel_results': 'list[ComponentSearchResultDTO]', + 'parameter_context_results': 'list[ComponentSearchResultDTO]', + 'parameter_results': 'list[ComponentSearchResultDTO]' } attribute_map = { @@ -47,10 +49,12 @@ class SearchResultsDTO(object): 'input_port_results': 'inputPortResults', 'output_port_results': 'outputPortResults', 'remote_process_group_results': 'remoteProcessGroupResults', - 'funnel_results': 'funnelResults' + 'funnel_results': 'funnelResults', + 'parameter_context_results': 'parameterContextResults', + 'parameter_results': 'parameterResults' } - def __init__(self, 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): + def __init__(self, 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, parameter_context_results=None, parameter_results=None): """ SearchResultsDTO - a model defined in Swagger """ @@ -62,6 +66,8 @@ def __init__(self, processor_results=None, connection_results=None, process_grou self._output_port_results = None self._remote_process_group_results = None self._funnel_results = None + self._parameter_context_results = None + self._parameter_results = None if processor_results is not None: self.processor_results = processor_results @@ -77,6 +83,10 @@ def __init__(self, processor_results=None, connection_results=None, process_grou self.remote_process_group_results = remote_process_group_results if funnel_results is not None: self.funnel_results = funnel_results + if parameter_context_results is not None: + self.parameter_context_results = parameter_context_results + if parameter_results is not None: + self.parameter_results = parameter_results @property def processor_results(self): @@ -239,6 +249,52 @@ def funnel_results(self, funnel_results): self._funnel_results = funnel_results + @property + def parameter_context_results(self): + """ + Gets the parameter_context_results of this SearchResultsDTO. + The parameter contexts that matched the search. + + :return: The parameter_context_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._parameter_context_results + + @parameter_context_results.setter + def parameter_context_results(self, parameter_context_results): + """ + Sets the parameter_context_results of this SearchResultsDTO. + The parameter contexts that matched the search. + + :param parameter_context_results: The parameter_context_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._parameter_context_results = parameter_context_results + + @property + def parameter_results(self): + """ + Gets the parameter_results of this SearchResultsDTO. + The parameters that matched the search. + + :return: The parameter_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._parameter_results + + @parameter_results.setter + def parameter_results(self, parameter_results): + """ + Sets the parameter_results of this SearchResultsDTO. + The parameters that matched the search. + + :param parameter_results: The parameter_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._parameter_results = parameter_results + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/search_results_entity.py b/nipyapi/nifi/models/search_results_entity.py index df0f9848..898f05a6 100644 --- a/nipyapi/nifi/models/search_results_entity.py +++ b/nipyapi/nifi/models/search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_dto.py b/nipyapi/nifi/models/snippet_dto.py index 8500e95b..3de52765 100644 --- a/nipyapi/nifi/models/snippet_dto.py +++ b/nipyapi/nifi/models/snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_entity.py b/nipyapi/nifi/models/snippet_entity.py index ebddfaa4..e14ddf1a 100644 --- a/nipyapi/nifi/models/snippet_entity.py +++ b/nipyapi/nifi/models/snippet_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/start_version_control_request_entity.py b/nipyapi/nifi/models/start_version_control_request_entity.py index 8cbae61d..22f1f5fe 100644 --- a/nipyapi/nifi/models/start_version_control_request_entity.py +++ b/nipyapi/nifi/models/start_version_control_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_entry_dto.py b/nipyapi/nifi/models/state_entry_dto.py index 94ef6dcd..ef85d53e 100644 --- a/nipyapi/nifi/models/state_entry_dto.py +++ b/nipyapi/nifi/models/state_entry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_map_dto.py b/nipyapi/nifi/models/state_map_dto.py index 3dd5dc43..8b4d3ffb 100644 --- a/nipyapi/nifi/models/state_map_dto.py +++ b/nipyapi/nifi/models/state_map_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_descriptor_dto.py b/nipyapi/nifi/models/status_descriptor_dto.py index cf75511f..03e03cfe 100644 --- a/nipyapi/nifi/models/status_descriptor_dto.py +++ b/nipyapi/nifi/models/status_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_dto.py b/nipyapi/nifi/models/status_history_dto.py index ecb1f725..77e49798 100644 --- a/nipyapi/nifi/models/status_history_dto.py +++ b/nipyapi/nifi/models/status_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_entity.py b/nipyapi/nifi/models/status_history_entity.py index 910ec3bd..a44d86ed 100644 --- a/nipyapi/nifi/models/status_history_entity.py +++ b/nipyapi/nifi/models/status_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_snapshot_dto.py b/nipyapi/nifi/models/status_snapshot_dto.py index af8d54d7..bb530ba0 100644 --- a/nipyapi/nifi/models/status_snapshot_dto.py +++ b/nipyapi/nifi/models/status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/storage_usage_dto.py b/nipyapi/nifi/models/storage_usage_dto.py index 9d0ecbe7..f056fd40 100644 --- a/nipyapi/nifi/models/storage_usage_dto.py +++ b/nipyapi/nifi/models/storage_usage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/streaming_output.py b/nipyapi/nifi/models/streaming_output.py index f9509e66..1c78e22c 100644 --- a/nipyapi/nifi/models/streaming_output.py +++ b/nipyapi/nifi/models/streaming_output.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/submit_replay_request_entity.py b/nipyapi/nifi/models/submit_replay_request_entity.py index 8efa2490..5fe85285 100644 --- a/nipyapi/nifi/models/submit_replay_request_entity.py +++ b/nipyapi/nifi/models/submit_replay_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_dto.py b/nipyapi/nifi/models/system_diagnostics_dto.py index a445f410..dd2f57a5 100644 --- a/nipyapi/nifi/models/system_diagnostics_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_entity.py b/nipyapi/nifi/models/system_diagnostics_entity.py index 05b8ab7f..277324c8 100644 --- a/nipyapi/nifi/models/system_diagnostics_entity.py +++ b/nipyapi/nifi/models/system_diagnostics_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py index f527d5a8..15c19574 100644 --- a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_dto.py b/nipyapi/nifi/models/template_dto.py index 77a33958..21860da0 100644 --- a/nipyapi/nifi/models/template_dto.py +++ b/nipyapi/nifi/models/template_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_entity.py b/nipyapi/nifi/models/template_entity.py index 56a878f6..89eeb656 100644 --- a/nipyapi/nifi/models/template_entity.py +++ b/nipyapi/nifi/models/template_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/templates_entity.py b/nipyapi/nifi/models/templates_entity.py index beb8dc4f..2e7427ed 100644 --- a/nipyapi/nifi/models/templates_entity.py +++ b/nipyapi/nifi/models/templates_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_dto.py b/nipyapi/nifi/models/tenant_dto.py index fe9577dd..3f422cef 100644 --- a/nipyapi/nifi/models/tenant_dto.py +++ b/nipyapi/nifi/models/tenant_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_entity.py b/nipyapi/nifi/models/tenant_entity.py index 895d976b..b36b1fb1 100644 --- a/nipyapi/nifi/models/tenant_entity.py +++ b/nipyapi/nifi/models/tenant_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenants_entity.py b/nipyapi/nifi/models/tenants_entity.py index 3ef3e5db..5d22bf6a 100644 --- a/nipyapi/nifi/models/tenants_entity.py +++ b/nipyapi/nifi/models/tenants_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/transaction_result_entity.py b/nipyapi/nifi/models/transaction_result_entity.py index 5da3b569..f272ee90 100644 --- a/nipyapi/nifi/models/transaction_result_entity.py +++ b/nipyapi/nifi/models/transaction_result_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py index 128dda66..86c190c9 100644 --- a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py +++ b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_dto.py b/nipyapi/nifi/models/user_dto.py index 182ce080..3fe296e2 100644 --- a/nipyapi/nifi/models/user_dto.py +++ b/nipyapi/nifi/models/user_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_entity.py b/nipyapi/nifi/models/user_entity.py index fc2e2125..b164c99c 100644 --- a/nipyapi/nifi/models/user_entity.py +++ b/nipyapi/nifi/models/user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_dto.py b/nipyapi/nifi/models/user_group_dto.py index 98cf6c6d..20586b59 100644 --- a/nipyapi/nifi/models/user_group_dto.py +++ b/nipyapi/nifi/models/user_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_entity.py b/nipyapi/nifi/models/user_group_entity.py index b2d0b5af..f7cc59fd 100644 --- a/nipyapi/nifi/models/user_group_entity.py +++ b/nipyapi/nifi/models/user_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_groups_entity.py b/nipyapi/nifi/models/user_groups_entity.py index 4257b56b..10913ec1 100644 --- a/nipyapi/nifi/models/user_groups_entity.py +++ b/nipyapi/nifi/models/user_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/users_entity.py b/nipyapi/nifi/models/users_entity.py index 78890638..1ce9b882 100644 --- a/nipyapi/nifi/models/users_entity.py +++ b/nipyapi/nifi/models/users_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_dto.py b/nipyapi/nifi/models/variable_dto.py index 2f3090d7..a81874a8 100644 --- a/nipyapi/nifi/models/variable_dto.py +++ b/nipyapi/nifi/models/variable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_entity.py b/nipyapi/nifi/models/variable_entity.py index 6146b16c..eac6823d 100644 --- a/nipyapi/nifi/models/variable_entity.py +++ b/nipyapi/nifi/models/variable_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_dto.py b/nipyapi/nifi/models/variable_registry_dto.py index c858fd14..990432b5 100644 --- a/nipyapi/nifi/models/variable_registry_dto.py +++ b/nipyapi/nifi/models/variable_registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_entity.py b/nipyapi/nifi/models/variable_registry_entity.py index 00c914db..c0e7030f 100644 --- a/nipyapi/nifi/models/variable_registry_entity.py +++ b/nipyapi/nifi/models/variable_registry_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_dto.py b/nipyapi/nifi/models/variable_registry_update_request_dto.py index fe7a843c..01226e23 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -32,47 +32,51 @@ class VariableRegistryUpdateRequestDTO(object): """ swagger_types = { 'request_id': 'str', - 'process_group_id': 'str', 'uri': 'str', - 'submission_time': 'str', - 'last_updated': 'str', + 'submission_time': 'datetime', + 'last_updated': 'datetime', 'complete': 'bool', 'failure_reason': 'str', + 'percent_completed': 'int', + 'state': 'str', 'update_steps': 'list[VariableRegistryUpdateStepDTO]', + 'process_group_id': 'str', 'affected_components': 'list[AffectedComponentEntity]' } attribute_map = { 'request_id': 'requestId', - 'process_group_id': 'processGroupId', 'uri': 'uri', 'submission_time': 'submissionTime', 'last_updated': 'lastUpdated', 'complete': 'complete', 'failure_reason': 'failureReason', + 'percent_completed': 'percentCompleted', + 'state': 'state', 'update_steps': 'updateSteps', + 'process_group_id': 'processGroupId', 'affected_components': 'affectedComponents' } - def __init__(self, request_id=None, process_group_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, update_steps=None, affected_components=None): + def __init__(self, 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): """ VariableRegistryUpdateRequestDTO - a model defined in Swagger """ self._request_id = None - self._process_group_id = None self._uri = None self._submission_time = None self._last_updated = None self._complete = None self._failure_reason = None + self._percent_completed = None + self._state = None self._update_steps = None + self._process_group_id = None self._affected_components = None if request_id is not None: self.request_id = request_id - if process_group_id is not None: - self.process_group_id = process_group_id if uri is not None: self.uri = uri if submission_time is not None: @@ -83,8 +87,14 @@ def __init__(self, request_id=None, process_group_id=None, uri=None, submission_ self.complete = complete if failure_reason is not None: self.failure_reason = failure_reason + if percent_completed is not None: + self.percent_completed = percent_completed + if state is not None: + self.state = state if update_steps is not None: self.update_steps = update_steps + if process_group_id is not None: + self.process_group_id = process_group_id if affected_components is not None: self.affected_components = affected_components @@ -92,7 +102,7 @@ def __init__(self, request_id=None, process_group_id=None, uri=None, submission_ def request_id(self): """ Gets the request_id of this VariableRegistryUpdateRequestDTO. - The unique ID of this request. + The ID of the request :return: The request_id of this VariableRegistryUpdateRequestDTO. :rtype: str @@ -103,7 +113,7 @@ def request_id(self): def request_id(self, request_id): """ Sets the request_id of this VariableRegistryUpdateRequestDTO. - The unique ID of this request. + The ID of the request :param request_id: The request_id of this VariableRegistryUpdateRequestDTO. :type: str @@ -111,34 +121,11 @@ def request_id(self, request_id): self._request_id = request_id - @property - def process_group_id(self): - """ - Gets the process_group_id of this VariableRegistryUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to - - :return: The process_group_id of this VariableRegistryUpdateRequestDTO. - :rtype: str - """ - return self._process_group_id - - @process_group_id.setter - def process_group_id(self, process_group_id): - """ - Sets the process_group_id of this VariableRegistryUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to - - :param process_group_id: The process_group_id of this VariableRegistryUpdateRequestDTO. - :type: str - """ - - self._process_group_id = process_group_id - @property def uri(self): """ Gets the uri of this VariableRegistryUpdateRequestDTO. - The URI for future requests to this drop request. + The URI for the request :return: The uri of this VariableRegistryUpdateRequestDTO. :rtype: str @@ -149,7 +136,7 @@ def uri(self): def uri(self, uri): """ Sets the uri of this VariableRegistryUpdateRequestDTO. - The URI for future requests to this drop request. + The URI for the request :param uri: The uri of this VariableRegistryUpdateRequestDTO. :type: str @@ -161,10 +148,10 @@ def uri(self, uri): def submission_time(self): """ Gets the submission_time of this VariableRegistryUpdateRequestDTO. - The time at which this request was submitted. + The timestamp of when the request was submitted :return: The submission_time of this VariableRegistryUpdateRequestDTO. - :rtype: str + :rtype: datetime """ return self._submission_time @@ -172,10 +159,10 @@ def submission_time(self): def submission_time(self, submission_time): """ Sets the submission_time of this VariableRegistryUpdateRequestDTO. - The time at which this request was submitted. + The timestamp of when the request was submitted :param submission_time: The submission_time of this VariableRegistryUpdateRequestDTO. - :type: str + :type: datetime """ self._submission_time = submission_time @@ -184,10 +171,10 @@ def submission_time(self, submission_time): def last_updated(self): """ Gets the last_updated of this VariableRegistryUpdateRequestDTO. - The last time this request was updated. + The timestamp of when the request was last updated :return: The last_updated of this VariableRegistryUpdateRequestDTO. - :rtype: str + :rtype: datetime """ return self._last_updated @@ -195,10 +182,10 @@ def last_updated(self): def last_updated(self, last_updated): """ Sets the last_updated of this VariableRegistryUpdateRequestDTO. - The last time this request was updated. + The timestamp of when the request was last updated :param last_updated: The last_updated of this VariableRegistryUpdateRequestDTO. - :type: str + :type: datetime """ self._last_updated = last_updated @@ -207,7 +194,7 @@ def last_updated(self, last_updated): def complete(self): """ Gets the complete of this VariableRegistryUpdateRequestDTO. - Whether or not this request has completed + Whether or not the request is completed :return: The complete of this VariableRegistryUpdateRequestDTO. :rtype: bool @@ -218,7 +205,7 @@ def complete(self): def complete(self, complete): """ Sets the complete of this VariableRegistryUpdateRequestDTO. - Whether or not this request has completed + Whether or not the request is completed :param complete: The complete of this VariableRegistryUpdateRequestDTO. :type: bool @@ -230,7 +217,7 @@ def complete(self, complete): def failure_reason(self): """ Gets the failure_reason of this VariableRegistryUpdateRequestDTO. - An explanation of why this request failed, or null if this request has not failed + The reason for the request failing, or null if the request has not failed :return: The failure_reason of this VariableRegistryUpdateRequestDTO. :rtype: str @@ -241,7 +228,7 @@ def failure_reason(self): def failure_reason(self, failure_reason): """ Sets the failure_reason of this VariableRegistryUpdateRequestDTO. - An explanation of why this request failed, or null if this request has not failed + The reason for the request failing, or null if the request has not failed :param failure_reason: The failure_reason of this VariableRegistryUpdateRequestDTO. :type: str @@ -249,6 +236,52 @@ def failure_reason(self, failure_reason): self._failure_reason = failure_reason + @property + def percent_completed(self): + """ + Gets the percent_completed of this VariableRegistryUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this VariableRegistryUpdateRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this VariableRegistryUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this VariableRegistryUpdateRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def state(self): + """ + Gets the state of this VariableRegistryUpdateRequestDTO. + A description of the current state of the request + + :return: The state of this VariableRegistryUpdateRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this VariableRegistryUpdateRequestDTO. + A description of the current state of the request + + :param state: The state of this VariableRegistryUpdateRequestDTO. + :type: str + """ + + self._state = state + @property def update_steps(self): """ @@ -272,6 +305,29 @@ def update_steps(self, update_steps): self._update_steps = update_steps + @property + def process_group_id(self): + """ + Gets the process_group_id of this VariableRegistryUpdateRequestDTO. + The unique ID of the Process Group that the variable registry belongs to + + :return: The process_group_id of this VariableRegistryUpdateRequestDTO. + :rtype: str + """ + return self._process_group_id + + @process_group_id.setter + def process_group_id(self, process_group_id): + """ + Sets the process_group_id of this VariableRegistryUpdateRequestDTO. + The unique ID of the Process Group that the variable registry belongs to + + :param process_group_id: The process_group_id of this VariableRegistryUpdateRequestDTO. + :type: str + """ + + self._process_group_id = process_group_id + @property def affected_components(self): """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_entity.py b/nipyapi/nifi/models/variable_registry_update_request_entity.py index 1cb27581..b48eed36 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_entity.py +++ b/nipyapi/nifi/models/variable_registry_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_step_dto.py b/nipyapi/nifi/models/variable_registry_update_step_dto.py index 971bbb0e..591b61c8 100644 --- a/nipyapi/nifi/models/variable_registry_update_step_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_component_mapping_entity.py b/nipyapi/nifi/models/version_control_component_mapping_entity.py index 91095b04..21bf8e78 100644 --- a/nipyapi/nifi/models/version_control_component_mapping_entity.py +++ b/nipyapi/nifi/models/version_control_component_mapping_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_dto.py b/nipyapi/nifi/models/version_control_information_dto.py index cb18a9b2..17cadd46 100644 --- a/nipyapi/nifi/models/version_control_information_dto.py +++ b/nipyapi/nifi/models/version_control_information_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_entity.py b/nipyapi/nifi/models/version_control_information_entity.py index 8c8d5634..e7e81d3f 100644 --- a/nipyapi/nifi/models/version_control_information_entity.py +++ b/nipyapi/nifi/models/version_control_information_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_info_dto.py b/nipyapi/nifi/models/version_info_dto.py index 1079771f..bd121b13 100644 --- a/nipyapi/nifi/models/version_info_dto.py +++ b/nipyapi/nifi/models/version_info_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_connection.py b/nipyapi/nifi/models/versioned_connection.py index 2acd64e4..e44126c4 100644 --- a/nipyapi/nifi/models/versioned_connection.py +++ b/nipyapi/nifi/models/versioned_connection.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_controller_service.py b/nipyapi/nifi/models/versioned_controller_service.py index 3285a193..2a84bd26 100644 --- a/nipyapi/nifi/models/versioned_controller_service.py +++ b/nipyapi/nifi/models/versioned_controller_service.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow.py b/nipyapi/nifi/models/versioned_flow.py index 5819b23b..10531bd5 100644 --- a/nipyapi/nifi/models/versioned_flow.py +++ b/nipyapi/nifi/models/versioned_flow.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,7 +31,7 @@ class VersionedFlow(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'identifier': 'str', 'name': 'str', 'description': 'str', @@ -102,7 +102,7 @@ def link(self): An WebLink to this entity. :return: The link of this VersionedFlow. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -113,7 +113,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this VersionedFlow. - :type: Link + :type: JaxbLink """ self._link = link @@ -309,7 +309,7 @@ def type(self, type): """ if type is None: raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["Flow"] + allowed_values = ["Flow", "Bundle"] if type not in allowed_values: raise ValueError( "Invalid value for `type` ({0}), must be one of {1}" diff --git a/nipyapi/nifi/models/versioned_flow_coordinates.py b/nipyapi/nifi/models/versioned_flow_coordinates.py index 5fbc4da3..a975d740 100644 --- a/nipyapi/nifi/models/versioned_flow_coordinates.py +++ b/nipyapi/nifi/models/versioned_flow_coordinates.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_dto.py b/nipyapi/nifi/models/versioned_flow_dto.py index fdf7d0bf..aa5aff88 100644 --- a/nipyapi/nifi/models/versioned_flow_dto.py +++ b/nipyapi/nifi/models/versioned_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -36,7 +36,8 @@ class VersionedFlowDTO(object): 'flow_id': 'str', 'flow_name': 'str', 'description': 'str', - 'comments': 'str' + 'comments': 'str', + 'action': 'str' } attribute_map = { @@ -45,10 +46,11 @@ class VersionedFlowDTO(object): 'flow_id': 'flowId', 'flow_name': 'flowName', 'description': 'description', - 'comments': 'comments' + 'comments': 'comments', + 'action': 'action' } - def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=None, description=None, comments=None): + def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=None, description=None, comments=None, action=None): """ VersionedFlowDTO - a model defined in Swagger """ @@ -59,6 +61,7 @@ def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=Non self._flow_name = None self._description = None self._comments = None + self._action = None if registry_id is not None: self.registry_id = registry_id @@ -72,6 +75,8 @@ def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=Non self.description = description if comments is not None: self.comments = comments + if action is not None: + self.action = action @property def registry_id(self): @@ -211,6 +216,35 @@ def comments(self, comments): self._comments = comments + @property + def action(self): + """ + Gets the action of this VersionedFlowDTO. + The action being performed + + :return: The action of this VersionedFlowDTO. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this VersionedFlowDTO. + The action being performed + + :param action: The action of this VersionedFlowDTO. + :type: str + """ + allowed_values = ["COMMIT", "FORCE_COMMIT"] + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" + .format(action, allowed_values) + ) + + self._action = action + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_flow_entity.py b/nipyapi/nifi/models/versioned_flow_entity.py index db53f82e..1a8e4c1d 100644 --- a/nipyapi/nifi/models/versioned_flow_entity.py +++ b/nipyapi/nifi/models/versioned_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot.py b/nipyapi/nifi/models/versioned_flow_snapshot.py index abe23a56..851d97ae 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,6 +33,9 @@ class VersionedFlowSnapshot(object): swagger_types = { 'snapshot_metadata': 'VersionedFlowSnapshotMetadata', 'flow_contents': 'VersionedProcessGroup', + 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', + 'parameter_contexts': 'dict(str, VersionedParameterContext)', + 'flow_encoding_version': 'str', 'flow': 'VersionedFlow', 'bucket': 'Bucket', 'latest': 'bool' @@ -41,24 +44,36 @@ class VersionedFlowSnapshot(object): attribute_map = { 'snapshot_metadata': 'snapshotMetadata', 'flow_contents': 'flowContents', + 'external_controller_services': 'externalControllerServices', + 'parameter_contexts': 'parameterContexts', + 'flow_encoding_version': 'flowEncodingVersion', 'flow': 'flow', 'bucket': 'bucket', 'latest': 'latest' } - def __init__(self, snapshot_metadata=None, flow_contents=None, flow=None, bucket=None, latest=None): + def __init__(self, snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None): """ VersionedFlowSnapshot - a model defined in Swagger """ self._snapshot_metadata = None self._flow_contents = None + self._external_controller_services = None + self._parameter_contexts = None + self._flow_encoding_version = None self._flow = None self._bucket = None self._latest = None self.snapshot_metadata = snapshot_metadata self.flow_contents = flow_contents + if external_controller_services is not None: + self.external_controller_services = external_controller_services + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if flow_encoding_version is not None: + self.flow_encoding_version = flow_encoding_version if flow is not None: self.flow = flow if bucket is not None: @@ -116,6 +131,75 @@ def flow_contents(self, flow_contents): self._flow_contents = flow_contents + @property + def external_controller_services(self): + """ + 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. + + :return: The external_controller_services of this VersionedFlowSnapshot. + :rtype: dict(str, ExternalControllerServiceReference) + """ + return self._external_controller_services + + @external_controller_services.setter + def external_controller_services(self, external_controller_services): + """ + Sets 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. + + :param external_controller_services: The external_controller_services of this VersionedFlowSnapshot. + :type: dict(str, ExternalControllerServiceReference) + """ + + self._external_controller_services = external_controller_services + + @property + def parameter_contexts(self): + """ + 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. + + :return: The parameter_contexts of this VersionedFlowSnapshot. + :rtype: dict(str, VersionedParameterContext) + """ + return self._parameter_contexts + + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): + """ + Sets 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. + + :param parameter_contexts: The parameter_contexts of this VersionedFlowSnapshot. + :type: dict(str, VersionedParameterContext) + """ + + self._parameter_contexts = parameter_contexts + + @property + def flow_encoding_version(self): + """ + Gets the flow_encoding_version of this VersionedFlowSnapshot. + The optional encoding version of the flow contents. + + :return: The flow_encoding_version of this VersionedFlowSnapshot. + :rtype: str + """ + return self._flow_encoding_version + + @flow_encoding_version.setter + def flow_encoding_version(self, flow_encoding_version): + """ + Sets the flow_encoding_version of this VersionedFlowSnapshot. + The optional encoding version of the flow contents. + + :param flow_encoding_version: The flow_encoding_version of this VersionedFlowSnapshot. + :type: str + """ + + self._flow_encoding_version = flow_encoding_version + @property def flow(self): """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py index 6ed0af57..df19d8b4 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py index 61fe1bad..1558c7ab 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,7 +31,7 @@ class VersionedFlowSnapshotMetadata(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'bucket_identifier': 'str', 'flow_identifier': 'str', 'version': 'int', @@ -82,7 +82,7 @@ def link(self): An WebLink to this entity. :return: The link of this VersionedFlowSnapshotMetadata. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -93,7 +93,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this VersionedFlowSnapshotMetadata. - :type: Link + :type: JaxbLink """ self._link = link @@ -170,8 +170,8 @@ def version(self, version): """ if version is None: raise ValueError("Invalid value for `version`, must not be `None`") - if version is not None and version < 1: - raise ValueError("Invalid value for `version`, must be a value greater than or equal to `1`") + if version is not None and version < -1: + raise ValueError("Invalid value for `version`, must be a value greater than or equal to `-1`") self._version = version diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py index 010b9022..fba55a20 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py index d83e97f5..656e68cd 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_dto.py b/nipyapi/nifi/models/versioned_flow_update_request_dto.py index 523915b3..6dd65c37 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_dto.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_entity.py b/nipyapi/nifi/models/versioned_flow_update_request_entity.py index 0d3239aa..56b56c63 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_entity.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flows_entity.py b/nipyapi/nifi/models/versioned_flows_entity.py index 9917dab1..c5dbeb6b 100644 --- a/nipyapi/nifi/models/versioned_flows_entity.py +++ b/nipyapi/nifi/models/versioned_flows_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_funnel.py b/nipyapi/nifi/models/versioned_funnel.py index bc5450ef..1d6c467c 100644 --- a/nipyapi/nifi/models/versioned_funnel.py +++ b/nipyapi/nifi/models/versioned_funnel.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_label.py b/nipyapi/nifi/models/versioned_label.py index 58a271c8..03a12374 100644 --- a/nipyapi/nifi/models/versioned_label.py +++ b/nipyapi/nifi/models/versioned_label.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter.py b/nipyapi/nifi/models/versioned_parameter.py new file mode 100644 index 00000000..527d4cf8 --- /dev/null +++ b/nipyapi/nifi/models/versioned_parameter.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedParameter(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'sensitive': 'bool', + 'value': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'sensitive': 'sensitive', + 'value': 'value' + } + + def __init__(self, name=None, description=None, sensitive=None, value=None): + """ + VersionedParameter - a model defined in Swagger + """ + + self._name = None + self._description = None + self._sensitive = None + self._value = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if sensitive is not None: + self.sensitive = sensitive + if value is not None: + self.value = value + + @property + def name(self): + """ + Gets the name of this VersionedParameter. + The name of the parameter + + :return: The name of this VersionedParameter. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedParameter. + The name of the parameter + + :param name: The name of this VersionedParameter. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this VersionedParameter. + The description of the param + + :return: The description of this VersionedParameter. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VersionedParameter. + The description of the param + + :param description: The description of this VersionedParameter. + :type: str + """ + + self._description = description + + @property + def sensitive(self): + """ + Gets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :return: The sensitive of this VersionedParameter. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :param sensitive: The sensitive of this VersionedParameter. + :type: bool + """ + + self._sensitive = sensitive + + @property + def value(self): + """ + Gets the value of this VersionedParameter. + The value of the parameter + + :return: The value of this VersionedParameter. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this VersionedParameter. + The value of the parameter + + :param value: The value of this VersionedParameter. + :type: str + """ + + self._value = value + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedParameter): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/versioned_parameter_context.py b/nipyapi/nifi/models/versioned_parameter_context.py new file mode 100644 index 00000000..e6154bbf --- /dev/null +++ b/nipyapi/nifi/models/versioned_parameter_context.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedParameterContext(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'parameters': 'list[VersionedParameter]' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'parameters': 'parameters' + } + + def __init__(self, name=None, description=None, parameters=None): + """ + VersionedParameterContext - a model defined in Swagger + """ + + self._name = None + self._description = None + self._parameters = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if parameters is not None: + self.parameters = parameters + + @property + def name(self): + """ + Gets the name of this VersionedParameterContext. + The name of the context + + :return: The name of this VersionedParameterContext. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedParameterContext. + The name of the context + + :param name: The name of this VersionedParameterContext. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this VersionedParameterContext. + The description of the parameter context + + :return: The description of this VersionedParameterContext. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VersionedParameterContext. + The description of the parameter context + + :param description: The description of this VersionedParameterContext. + :type: str + """ + + self._description = description + + @property + def parameters(self): + """ + Gets the parameters of this VersionedParameterContext. + The parameters in the context + + :return: The parameters of this VersionedParameterContext. + :rtype: list[VersionedParameter] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this VersionedParameterContext. + The parameters in the context + + :param parameters: The parameters of this VersionedParameterContext. + :type: list[VersionedParameter] + """ + + self._parameters = parameters + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedParameterContext): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/versioned_port.py b/nipyapi/nifi/models/versioned_port.py index f349b47d..b4b5718d 100644 --- a/nipyapi/nifi/models/versioned_port.py +++ b/nipyapi/nifi/models/versioned_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -37,6 +37,8 @@ class VersionedPort(object): 'position': 'Position', 'type': 'str', 'concurrently_schedulable_task_count': 'int', + 'scheduled_state': 'str', + 'allow_remote_access': 'bool', 'component_type': 'str', 'group_identifier': 'str' } @@ -48,11 +50,13 @@ class VersionedPort(object): 'position': 'position', 'type': 'type', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', + 'scheduled_state': 'scheduledState', + 'allow_remote_access': 'allowRemoteAccess', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, component_type=None, group_identifier=None): + def __init__(self, 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): """ VersionedPort - a model defined in Swagger """ @@ -63,6 +67,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, typ self._position = None self._type = None self._concurrently_schedulable_task_count = None + self._scheduled_state = None + self._allow_remote_access = None self._component_type = None self._group_identifier = None @@ -78,6 +84,10 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, typ self.type = type if concurrently_schedulable_task_count is not None: self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if scheduled_state is not None: + self.scheduled_state = scheduled_state + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -227,6 +237,58 @@ def concurrently_schedulable_task_count(self, concurrently_schedulable_task_coun self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedPort. + The scheduled state of the component + + :return: The scheduled_state of this VersionedPort. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedPort. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedPort. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :return: The allow_remote_access of this VersionedPort. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :param allow_remote_access: The allow_remote_access of this VersionedPort. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + @property def component_type(self): """ diff --git a/nipyapi/nifi/models/versioned_process_group.py b/nipyapi/nifi/models/versioned_process_group.py index 4941d000..933c9439 100644 --- a/nipyapi/nifi/models/versioned_process_group.py +++ b/nipyapi/nifi/models/versioned_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -46,6 +46,7 @@ class VersionedProcessGroup(object): 'controller_services': 'list[VersionedControllerService]', 'versioned_flow_coordinates': 'VersionedFlowCoordinates', 'variables': 'dict(str, str)', + 'parameter_context_name': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -66,11 +67,12 @@ class VersionedProcessGroup(object): 'controller_services': 'controllerServices', 'versioned_flow_coordinates': 'versionedFlowCoordinates', 'variables': 'variables', + 'parameter_context_name': 'parameterContextName', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, component_type=None, group_identifier=None): + def __init__(self, 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, component_type=None, group_identifier=None): """ VersionedProcessGroup - a model defined in Swagger """ @@ -90,6 +92,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self._controller_services = None self._versioned_flow_coordinates = None self._variables = None + self._parameter_context_name = None self._component_type = None self._group_identifier = None @@ -123,6 +126,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self.versioned_flow_coordinates = versioned_flow_coordinates if variables is not None: self.variables = variables + if parameter_context_name is not None: + self.parameter_context_name = parameter_context_name if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -473,6 +478,29 @@ def variables(self, variables): self._variables = variables + @property + def parameter_context_name(self): + """ + Gets the parameter_context_name of this VersionedProcessGroup. + The name of the parameter context used by this process group + + :return: The parameter_context_name of this VersionedProcessGroup. + :rtype: str + """ + return self._parameter_context_name + + @parameter_context_name.setter + def parameter_context_name(self, parameter_context_name): + """ + Sets the parameter_context_name of this VersionedProcessGroup. + The name of the parameter context used by this process group + + :param parameter_context_name: The parameter_context_name of this VersionedProcessGroup. + :type: str + """ + + self._parameter_context_name = parameter_context_name + @property def component_type(self): """ diff --git a/nipyapi/nifi/models/versioned_processor.py b/nipyapi/nifi/models/versioned_processor.py index 7011410f..cdc04227 100644 --- a/nipyapi/nifi/models/versioned_processor.py +++ b/nipyapi/nifi/models/versioned_processor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -50,6 +50,7 @@ class VersionedProcessor(object): 'run_duration_millis': 'int', 'concurrently_schedulable_task_count': 'int', 'auto_terminated_relationships': 'list[str]', + 'scheduled_state': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -74,11 +75,12 @@ class VersionedProcessor(object): 'run_duration_millis': 'runDurationMillis', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'auto_terminated_relationships': 'autoTerminatedRelationships', + 'scheduled_state': 'scheduledState', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, name=None, comments=None, position=None, bundle=None, style=None, type=None, properties=None, property_descriptors=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, component_type=None, group_identifier=None): + def __init__(self, identifier=None, name=None, comments=None, position=None, bundle=None, style=None, type=None, properties=None, property_descriptors=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, component_type=None, group_identifier=None): """ VersionedProcessor - a model defined in Swagger """ @@ -102,6 +104,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, bun self._run_duration_millis = None self._concurrently_schedulable_task_count = None self._auto_terminated_relationships = None + self._scheduled_state = None self._component_type = None self._group_identifier = None @@ -143,6 +146,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, bun self.concurrently_schedulable_task_count = concurrently_schedulable_task_count if auto_terminated_relationships is not None: self.auto_terminated_relationships = auto_terminated_relationships + if scheduled_state is not None: + self.scheduled_state = scheduled_state if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -585,6 +590,35 @@ def auto_terminated_relationships(self, auto_terminated_relationships): self._auto_terminated_relationships = auto_terminated_relationships + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedProcessor. + The scheduled state of the component + + :return: The scheduled_state of this VersionedProcessor. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedProcessor. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedProcessor. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + @property def component_type(self): """ diff --git a/nipyapi/nifi/models/versioned_property_descriptor.py b/nipyapi/nifi/models/versioned_property_descriptor.py index 199a378b..152334d8 100644 --- a/nipyapi/nifi/models/versioned_property_descriptor.py +++ b/nipyapi/nifi/models/versioned_property_descriptor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_group_port.py b/nipyapi/nifi/models/versioned_remote_group_port.py index d5da6963..d4aea84b 100644 --- a/nipyapi/nifi/models/versioned_remote_group_port.py +++ b/nipyapi/nifi/models/versioned_remote_group_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,6 +41,7 @@ class VersionedRemoteGroupPort(object): 'batch_size': 'BatchSize', 'component_type': 'str', 'target_id': 'str', + 'scheduled_state': 'str', 'group_identifier': 'str' } @@ -55,10 +56,11 @@ class VersionedRemoteGroupPort(object): 'batch_size': 'batchSize', 'component_type': 'componentType', 'target_id': 'targetId', + 'scheduled_state': 'scheduledState', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, group_identifier=None): + def __init__(self, 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): """ VersionedRemoteGroupPort - a model defined in Swagger """ @@ -73,6 +75,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, rem self._batch_size = None self._component_type = None self._target_id = None + self._scheduled_state = None self._group_identifier = None if identifier is not None: @@ -95,6 +98,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, rem self.component_type = component_type if target_id is not None: self.target_id = target_id + if scheduled_state is not None: + self.scheduled_state = scheduled_state if group_identifier is not None: self.group_identifier = group_identifier @@ -332,6 +337,35 @@ def target_id(self, target_id): self._target_id = target_id + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component + + :return: The scheduled_state of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedRemoteGroupPort. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + @property def group_identifier(self): """ diff --git a/nipyapi/nifi/models/versioned_remote_process_group.py b/nipyapi/nifi/models/versioned_remote_process_group.py index 4ea33c0f..d52562c7 100644 --- a/nipyapi/nifi/models/versioned_remote_process_group.py +++ b/nipyapi/nifi/models/versioned_remote_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index 2d2da280..12300be8 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 357adb4b..0425010e 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -248,7 +248,8 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, description=desc, flow_name=flow_name, flow_id=flow_id, - registry_id=registry_client.id + registry_id=registry_client.id, + action='COMMIT' ) ) ) diff --git a/resources/client_gen/api_defs/nifi-1.10.0-swagger.json b/resources/client_gen/api_defs/nifi-1.10.0-swagger.json new file mode 100644 index 00000000..4cc80c43 --- /dev/null +++ b/resources/client_gen/api_defs/nifi-1.10.0-swagger.json @@ -0,0 +1,20603 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", + "version" : "1.10.0", + "title" : "NiFi Rest Api", + "contact" : { + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-api", + "tags" : [ { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "connections", + "description" : "Endpoint for managing a Connection." + }, { + "name" : "controller", + "description" : "Provides realtime command and control of this NiFi instance" + }, { + "name" : "controller-services", + "description" : "Endpoint for managing a Controller Service." + }, { + "name" : "counters", + "description" : "Endpoint for managing counters." + }, { + "name" : "data-transfer", + "description" : "Supports data transfers with this NiFi using HTTP based site to site" + }, { + "name" : "flow", + "description" : "Endpoint for accessing the flow structure and component status." + }, { + "name" : "flowfile-queues", + "description" : "Endpoint for managing a FlowFile Queue." + }, { + "name" : "funnel", + "description" : "Endpoint for managing a Funnel." + }, { + "name" : "input-ports", + "description" : "Endpoint for managing an Input Port." + }, { + "name" : "labels", + "description" : "Endpoint for managing a Label." + }, { + "name" : "output-ports", + "description" : "Endpoint for managing an Output Port." + }, { + "name" : "parameter-contexts", + "description" : "Endpoint for managing version control for a flow" + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "process-groups", + "description" : "Endpoint for managing a Process Group." + }, { + "name" : "processors", + "description" : "Endpoint for managing a Processor." + }, { + "name" : "provenance", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "provenance-events", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "remote-process-groups", + "description" : "Endpoint for managing a Remote Process Group." + }, { + "name" : "reporting-tasks", + "description" : "Endpoint for managing a Reporting Task." + }, { + "name" : "resources", + "description" : "Provides the resources in this NiFi that can have access/authorization policies." + }, { + "name" : "site-to-site", + "description" : "Provide access to site to site with this NiFi" + }, { + "name" : "snippets", + "description" : "Endpoint for accessing dataflow snippets." + }, { + "name" : "system-diagnostics", + "description" : "Endpoint for accessing system diagnostics." + }, { + "name" : "templates", + "description" : "Endpoint for managing a Template." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + }, { + "name" : "versions", + "description" : "Endpoint for managing version control for a flow" + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Gets the status the client's access", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Unable to determine access status because the client could not be authenticated." + }, + "403" : { + "description" : "Unable to determine access status because the client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to determine access status because NiFi is not in the appropriate state." + }, + "500" : { + "description" : "Unable to determine access status because an unexpected error occurred." + } + } + } + }, + "/access/config" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Retrieves the access configuration for this NiFi", + "description" : "", + "operationId" : "getLoginConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessConfigurationEntity" + } + } + } + } + }, + "/access/download-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for downloading FlowFile content.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createDownloadToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/access/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", + "description" : "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 '.", + "operationId" : "createAccessTokenFromTicket", + "consumes" : [ "text/plain" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/knox/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/logout" : { + "delete" : { + "tags" : [ "access" ], + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOut", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/oidc/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/exchange" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcExchange", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + } + } + } + }, + "/access/oidc/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the OpenId Provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via username/password", + "description" : "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 '.", + "operationId" : "createAccessToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "username", + "in" : "formData", + "required" : false, + "type" : "string" + }, { + "name" : "password", + "in" : "formData", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/ui-extension-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for accessing a NiFi UI extension.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createUiExtensionToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/connections/{id}" : { + "get" : { + "tags" : [ "connections" ], + "summary" : "Gets a connection", + "description" : "", + "operationId" : "getConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source - /{component-type}/{uuid}" : [ ] + }, { + "Read Destination - /{component-type}/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "connections" ], + "summary" : "Updates a connection", + "description" : "", + "operationId" : "updateConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + }, { + "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] + }, { + "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] + } ] + }, + "delete" : { + "tags" : [ "connections" ], + "summary" : "Deletes a connection", + "description" : "", + "operationId" : "deleteConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller service", + "description" : "", + "operationId" : "updateControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller-services" ], + "summary" : "Deletes a controller service", + "description" : "", + "operationId" : "removeControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - Controller if scoped by Controller - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/descriptors" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name to return the descriptor for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/references" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerServiceReferences", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller services references", + "description" : "", + "operationId" : "updateControllerServiceReferences", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service request update request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] + } ] + } + }, + "/controller-services/{id}/run-status" : { + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates run status of a controller service", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets the state for a controller service", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "controller-services" ], + "summary" : "Clears the state for a controller service", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller/bulletin" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new bulletin", + "description" : "", + "operationId" : "createBulletin", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/cluster" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the contents of the cluster", + "description" : "Returns the contents of the cluster including all nodes and their status.", + "operationId" : "getCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + } + }, + "/controller/cluster/nodes/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a node in the cluster", + "description" : "", + "operationId" : "getNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a node in the cluster", + "description" : "", + "operationId" : "updateNode", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Removes a node from the cluster", + "description" : "", + "operationId" : "deleteNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/config" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi Controller", + "description" : "", + "operationId" : "getControllerConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi", + "description" : "", + "operationId" : "updateControllerConfig", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/controller-services" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/controller/history" : { + "delete" : { + "tags" : [ "controller" ], + "summary" : "Purges history", + "description" : "", + "operationId" : "deleteHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "endDate", + "in" : "query", + "description" : "Purge actions before this date/time.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the listing of available registry clients", + "description" : "", + "operationId" : "getRegistryClients", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new registry client", + "description" : "", + "operationId" : "createRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a registry client", + "description" : "", + "operationId" : "getRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a registry client", + "description" : "", + "operationId" : "updateRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Deletes a registry client", + "description" : "", + "operationId" : "deleteRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/reporting-tasks" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new reporting task", + "description" : "", + "operationId" : "createReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Reporting Task is restricted - /restricted-components" : [ ] + } ] + } + }, + "/counters" : { + "get" : { + "tags" : [ "counters" ], + "summary" : "Gets the current counters for this NiFi", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getCounters", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CountersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /counters" : [ ] + } ] + } + }, + "/counters/{id}" : { + "put" : { + "tags" : [ "counters" ], + "summary" : "Updates the specified counter. This will reset the counter value to 0", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateCounter", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The id of the counter.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CounterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /counters" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendInputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitInputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files to the input port", + "description" : "", + "operationId" : "receiveFlowFiles", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendOutputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitOutputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "checksum", + "in" : "query", + "description" : "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" : true, + "type" : "string" + }, { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { + "get" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files from the output port", + "description" : "", + "operationId" : "transferFlowFiles", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "There is no flow file to return.", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/{portType}/{portId}/transactions" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Create a transaction to the specified output port or input port", + "description" : "", + "operationId" : "createPortTransaction", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portType", + "in" : "path", + "description" : "The port type.", + "required" : true, + "type" : "string", + "enum" : [ "input-ports", "output-ports" ] + }, { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/about" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves details about this NiFi to put in the About dialog", + "description" : "", + "operationId" : "getAboutInfo", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AboutEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/banners" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the banners for this NiFi", + "description" : "", + "operationId" : "getBanners", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BannerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/bulletin-board" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets current bulletins", + "description" : "", + "operationId" : "getBulletinBoard", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "Includes bulletins with an id after this value.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceName", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose name match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "message", + "in" : "query", + "description" : "Includes bulletins whose message that match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "limit", + "in" : "query", + "description" : "The number of bulletins to limit the response to.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinBoardEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] + } ] + } + }, + "/flow/client-id" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Generates a client id.", + "description" : "", + "operationId" : "generateClientId", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Searches the cluster for a node with the specified address", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Node address to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterSearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/summary" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "The cluster summary for this NiFi", + "description" : "", + "operationId" : "getClusterSummary", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusteSummaryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/config" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the configuration for this NiFi flow", + "description" : "", + "operationId" : "getFlowConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/statistics" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets statistics for a connection", + "description" : "", + "operationId" : "getConnectionStatistics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the statistics.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatisticsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a connection", + "description" : "", + "operationId" : "getConnectionStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history for a connection", + "description" : "", + "operationId" : "getConnectionStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller-service-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of controller services that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getControllerServiceTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "serviceType", + "in" : "query", + "description" : "If specified, will only return controller services that are compatible with this type of service.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleGroup", + "in" : "query", + "description" : "If serviceType specified, is the bundle group of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleArtifact", + "in" : "query", + "description" : "If serviceType specified, is the bundle artifact of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleVersion", + "in" : "query", + "description" : "If serviceType specified, is the bundle version of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "typeFilter", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller/bulletins" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves Controller level bulletins", + "description" : "", + "operationId" : "getBulletins", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerBulletinsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /controller - For controller bulletins" : [ ] + }, { + "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] + }, { + "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] + } ] + } + }, + "/flow/controller/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets controller services for reporting tasks", + "description" : "", + "operationId" : "getControllerServicesFromController", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/current-user" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the user identity of the user making the request", + "description" : "", + "operationId" : "getCurrentUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUserEntity" + } + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "queryHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "The offset into the result set.", + "required" : true, + "type" : "string" + }, { + "name" : "count", + "in" : "query", + "description" : "The number of actions to return.", + "required" : true, + "type" : "string" + }, { + "name" : "sortColumn", + "in" : "query", + "description" : "The field to sort on.", + "required" : false, + "type" : "string" + }, { + "name" : "sortOrder", + "in" : "query", + "description" : "The direction to sort.", + "required" : false, + "type" : "string" + }, { + "name" : "startDate", + "in" : "query", + "description" : "Include actions after this date.", + "required" : false, + "type" : "string" + }, { + "name" : "endDate", + "in" : "query", + "description" : "Include actions before this date.", + "required" : false, + "type" : "string" + }, { + "name" : "userIdentity", + "in" : "query", + "description" : "Include actions performed by this user.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Include actions on this component.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history/components/{componentId}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history for a component", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getComponentHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "componentId", + "in" : "path", + "description" : "The component id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read underlying component - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/history/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets an action", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAction", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The action id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/input-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an input port", + "description" : "", + "operationId" : "getInputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/output-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an output port", + "description" : "", + "operationId" : "getOutputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/parameter-contexts" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all Parameter Contexts", + "description" : "", + "operationId" : "getParameterContexts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] + } ] + } + }, + "/flow/prioritizers" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of prioritizers that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getPrioritizers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PrioritizerTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupFlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Schedule or unschedule components in the specified Process Group.", + "description" : "", + "operationId" : "scheduleComponents", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all controller services", + "description" : "", + "operationId" : "getControllerServicesFromGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include parent/ancestory process groups", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Enable or disable Controller Services in the specified Process Group.", + "description" : "", + "operationId" : "activateControllerServices", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status for a process group", + "description" : "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.", + "operationId" : "getProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "recursive", + "in" : "query", + "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a remote process group", + "description" : "", + "operationId" : "getProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processor-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of processors that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a processor", + "description" : "", + "operationId" : "getProcessorStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a processor", + "description" : "", + "operationId" : "getProcessorStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the listing of available registries", + "description" : "", + "operationId" : "getRegistries", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{id}/buckets" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the buckets from the specified registry for the current user", + "description" : "", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BucketsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flows from the specified registry and bucket for the current user", + "description" : "", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", + "description" : "", + "operationId" : "getVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + }, { + "name" : "flow-id", + "in" : "path", + "description" : "The flow id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history", + "description" : "", + "operationId" : "getRemoteProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-task-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of reporting tasks that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReportingTaskTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-tasks" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all reporting tasks", + "description" : "", + "operationId" : "getReportingTasks", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTasksEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Performs a search against this NiFi using the specified search term", + "description" : "Only search results from authorized components will be returned.", + "operationId" : "searchFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the current status of this NiFi", + "description" : "", + "operationId" : "getControllerStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/templates" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all templates", + "description" : "", + "operationId" : "getTemplates", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplatesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Creates a request to drop the contents of the queue in this connection.", + "description" : "", + "operationId" : "createDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a drop request for the specified connection.", + "description" : "", + "operationId" : "getDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to drop the contents of this connection.", + "description" : "", + "operationId" : "removeDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets a FlowFile from a Connection.", + "description" : "", + "operationId" : "getFlowFile", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowFileEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the content for a FlowFile in a Connection.", + "description" : "", + "operationId" : "downloadFlowFileContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Lists the contents of the queue in this connection.", + "description" : "", + "operationId" : "createFlowFileListing", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a listing request for the specified connection.", + "description" : "", + "operationId" : "getListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to list the contents of this connection.", + "description" : "", + "operationId" : "deleteListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/funnels/{id}" : { + "get" : { + "tags" : [ "funnel" ], + "summary" : "Gets a funnel", + "description" : "", + "operationId" : "getFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /funnels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "funnel" ], + "summary" : "Updates a funnel", + "description" : "", + "operationId" : "updateFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "funnel" ], + "summary" : "Deletes a funnel", + "description" : "", + "operationId" : "removeFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}" : { + "get" : { + "tags" : [ "input-ports" ], + "summary" : "Gets an input port", + "description" : "", + "operationId" : "getInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /input-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates an input port", + "description" : "", + "operationId" : "updateInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "input-ports" ], + "summary" : "Deletes an input port", + "description" : "", + "operationId" : "removeInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}/run-status" : { + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates run status of an input-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] + } ] + } + }, + "/labels/{id}" : { + "get" : { + "tags" : [ "labels" ], + "summary" : "Gets a label", + "description" : "", + "operationId" : "getLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /labels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "labels" ], + "summary" : "Updates a label", + "description" : "", + "operationId" : "updateLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "labels" ], + "summary" : "Deletes a label", + "description" : "", + "operationId" : "removeLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}" : { + "get" : { + "tags" : [ "output-ports" ], + "summary" : "Gets an output port", + "description" : "", + "operationId" : "getOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /output-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates an output port", + "description" : "", + "operationId" : "updateOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "output-ports" ], + "summary" : "Deletes an output port", + "description" : "", + "operationId" : "removeOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}/run-status" : { + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates run status of an output-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] + } ] + } + }, + "/parameter-contexts" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Create a Parameter Context", + "description" : "", + "operationId" : "createParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The Parameter Context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-contexts" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate the Update Request of a Parameter Context", + "description" : "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 acttion 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}.", + "operationId" : "submitParameterContextUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated version of the parameter context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Write - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests/{requestId}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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. ", + "operationId" : "getParameterContextUpdate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the ParameterContext", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", + "description" : "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}.", + "operationId" : "submitValidationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The validation request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Validation Request with the given ID", + "description" : "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. ", + "operationId" : "getValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Validation Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Validation Request with the given ID", + "description" : "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.", + "operationId" : "deleteValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Parameter Context with the given ID", + "description" : "Returns the Parameter Context with the given ID.", + "operationId" : "getParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ] + }, + "put" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Modifies a Parameter Context", + "description" : "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.", + "operationId" : "updateParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated Parameter Context", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + }, { + "Write - /parameter-contexts/{id}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Parameter Context with the given ID", + "description" : "Deletes the Parameter Context with the given ID.", + "operationId" : "deleteParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The Parameter Context ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{uuid}" : [ ] + }, { + "Write - /parameter-contexts/{uuid}" : [ ] + }, { + "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + }, { + "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + } ] + } + }, + "/policies" : { + "post" : { + "tags" : [ "policies" ], + "summary" : "Creates an access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy for the specified action and resource", + "description" : "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.", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Updates a access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Deletes an access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + }, { + "Write - Policy of the parent resource - /policies/{resource}" : [ ] + } ] + } + }, + "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates a process group", + "description" : "", + "operationId" : "updateProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes a process group", + "description" : "", + "operationId" : "removeProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/connections" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all connections", + "description" : "", + "operationId" : "getConnections", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a connection", + "description" : "", + "operationId" : "createConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/controller-services" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/funnels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all funnels", + "description" : "", + "operationId" : "getFunnels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a funnel", + "description" : "", + "operationId" : "createFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/input-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all input ports", + "description" : "", + "operationId" : "getInputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/InputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an input port", + "description" : "", + "operationId" : "createInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/labels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all labels", + "description" : "", + "operationId" : "getLabels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a label", + "description" : "", + "operationId" : "createLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/local-modifications" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", + "description" : "", + "operationId" : "getLocalModifications", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowComparisonEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/output-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all output ports", + "description" : "", + "operationId" : "getOutputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/OutputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an output port", + "description" : "", + "operationId" : "createOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all process groups", + "description" : "", + "operationId" : "getProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a process group", + "description" : "", + "operationId" : "createProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/processors" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all processors", + "description" : "", + "operationId" : "getProcessors", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include processors from descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new processor", + "description" : "", + "operationId" : "createProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Processor is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/remote-process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all remote process groups", + "description" : "", + "operationId" : "getRemoteProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new process group", + "description" : "", + "operationId" : "createRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/snippet-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Copies a snippet and discards it.", + "description" : "", + "operationId" : "copySnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The copy snippet request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CopySnippetRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + }, { + "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/template-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Instantiates a template", + "description" : "", + "operationId" : "instantiateTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The instantiate template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/InstantiateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /templates/{uuid}" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a template and discards the specified snippet.", + "description" : "", + "operationId" : "createTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The create template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/import" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Imports a template", + "description" : "", + "operationId" : "importTemplate", + "consumes" : [ "application/xml" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/upload" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Uploads a template", + "description" : "", + "operationId" : "uploadTemplate", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "template", + "in" : "formData", + "description" : "The binary content of the template file being uploaded.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistry", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include ancestor groups", + "required" : false, + "type" : "boolean", + "default" : true + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates the contents of a Process Group's variable Registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVariableRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry/update-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Submits a request to update a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "submitUpdateVariableRegistryRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets a processor", + "description" : "", + "operationId" : "getProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates a processor", + "description" : "", + "operationId" : "updateProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "processors" ], + "summary" : "Deletes a processor", + "description" : "", + "operationId" : "deleteProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/descriptors" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the descriptor for a processor property", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/diagnostics" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets diagnostics information about a processor", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/run-status" : { + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates run status of a processor", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the state for a processor", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Clears the state for a processor", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/threads" : { + "delete" : { + "tags" : [ "processors" ], + "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", + "description" : "", + "operationId" : "terminateProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/provenance" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a provenance query", + "description" : "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.", + "operationId" : "submitProvenanceRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The provenance query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/replays" : { + "post" : { + "tags" : [ "provenance-events" ], + "summary" : "Replays content from a provenance event", + "description" : "", + "operationId" : "submitReplay", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The replay request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SubmitReplayRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets a provenance event", + "description" : "", + "operationId" : "getProvenanceEvent", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this event exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/input" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the input content for a provenance event", + "description" : "", + "operationId" : "getInputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/output" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the output content for a provenance event", + "description" : "", + "operationId" : "getOutputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a lineage query", + "description" : "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.", + "operationId" : "submitLineageRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The lineage query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a lineage query", + "description" : "", + "operationId" : "getLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a lineage query", + "description" : "", + "operationId" : "deleteLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/search-options" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets the searchable attributes for provenance events", + "description" : "", + "operationId" : "getSearchOptions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceOptionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a provenance query", + "description" : "", + "operationId" : "getProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "summarize", + "in" : "query", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "incrementalResults", + "in" : "query", + "description" : "Whether or not to summarize provenance events returned. This property is false by default.", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a provenance query", + "description" : "", + "operationId" : "deleteProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/remote-process-groups/{id}" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Deletes a remote process group", + "description" : "", + "operationId" : "removeRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroupRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/state" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets the state for a RemoteProcessGroup", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task", + "description" : "", + "operationId" : "getReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates a reporting task", + "description" : "", + "operationId" : "updateReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Deletes a reporting task", + "description" : "", + "operationId" : "removeReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/descriptors" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/run-status" : { + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates run status of a reporting task", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets the state for a reporting task", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Clears the state for a reporting task", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/resources" : { + "get" : { + "tags" : [ "resources" ], + "summary" : "Gets the available resources that support access/authorization policies", + "description" : "", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ResourcesEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /resources" : [ ] + } ] + } + }, + "/site-to-site" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the details about this NiFi necessary to communicate via site to site", + "description" : "", + "operationId" : "getSiteToSiteDetails", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/site-to-site/peers" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the available Peers and its status of this NiFi", + "description" : "", + "operationId" : "getPeers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json", "application/xml" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PeersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/snippets" : { + "post" : { + "tags" : [ "snippets" ], + "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", + "description" : "", + "operationId" : "createSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] + } ] + } + }, + "/snippets/{id}" : { + "put" : { + "tags" : [ "snippets" ], + "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", + "description" : "", + "operationId" : "updateSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + } ] + }, + "delete" : { + "tags" : [ "snippets" ], + "summary" : "Deletes the components in a snippet and discards the snippet", + "description" : "", + "operationId" : "deleteSnippet", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/system-diagnostics" : { + "get" : { + "tags" : [ "system-diagnostics" ], + "summary" : "Gets the diagnostics for the system NiFi is running on", + "description" : "", + "operationId" : "getSystemDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SystemDiagnosticsEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ] + } + }, + "/templates/{id}" : { + "delete" : { + "tags" : [ "templates" ], + "summary" : "Deletes a template", + "description" : "", + "operationId" : "removeTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /templates/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/templates/{id}/download" : { + "get" : { + "tags" : [ "templates" ], + "summary" : "Exports a template", + "description" : "", + "operationId" : "exportTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /templates/{uuid}" : [ ] + } ] + } + }, + "/tenants/search-results" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Searches for a tenant with the specified identity", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchTenants", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Identity to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TenantsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all user groups", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all users", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UsersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/versions/active-requests" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Create a version control request", + "description" : "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.", + "operationId" : "createVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateActiveRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/active-requests/{id}" : { + "put" : { + "tags" : [ "versions" ], + "summary" : "Updates the request with the given ID", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The version control component mapping.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlComponentMappingEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can update it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the version control request with the given ID", + "description" : "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.", + "operationId" : "deleteVersionControlRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/process-groups/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the Version Control information for a process group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVersionInformation", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "versions" ], + "summary" : "Save the Process Group with the given ID", + "description" : "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.", + "operationId" : "saveToFlowRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/StartVersionControlRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "versions" ], + "summary" : "Update the version of a Process Group with the given ID", + "description" : "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.", + "operationId" : "updateFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Stops version controlling the Process Group with the given ID", + "description" : "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.", + "operationId" : "stopVersionControl", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/revert-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Revert Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateRevertFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/revert-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Revert Request with the given ID", + "description" : "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.", + "operationId" : "getRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Revert Request with the given ID", + "description" : "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.", + "operationId" : "deleteRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/update-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Update Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateVersionControlUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/update-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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.", + "operationId" : "getUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + } + }, + "definitions" : { + "AboutDTO" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "The title to be used on the page and in the about dialog." + }, + "version" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "uri" : { + "type" : "string", + "description" : "The URI for the NiFi." + }, + "contentViewerUrl" : { + "type" : "string", + "description" : "The URL for the content viewer if configured." + }, + "timezone" : { + "type" : "string", + "description" : "The timezone of the NiFi instance.", + "readOnly" : true + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "description" : "Build timestamp" + } + } + }, + "AboutEntity" : { + "type" : "object", + "properties" : { + "about" : { + "$ref" : "#/definitions/AboutDTO" + } + }, + "xml" : { + "name" : "aboutEntity" + } + }, + "AccessConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsLogin" : { + "type" : "boolean", + "description" : "Indicates whether or not this NiFi supports user login.", + "readOnly" : true + } + } + }, + "AccessConfigurationEntity" : { + "type" : "object", + "properties" : { + "config" : { + "$ref" : "#/definitions/AccessConfigurationDTO" + } + }, + "xml" : { + "name" : "accessConfigurationEntity" + } + }, + "AccessPolicyDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + } + }, + "AccessPolicyEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicyDTO" + } + }, + "xml" : { + "name" : "accessPolicyEntity" + } + }, + "AccessPolicySummaryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + } + } + }, + "AccessPolicySummaryEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicySummaryDTO" + } + }, + "xml" : { + "name" : "accessPolicySummaryEntity" + } + }, + "AccessStatusDTO" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The user access status.", + "readOnly" : true + }, + "message" : { + "type" : "string", + "description" : "Additional details about the user access status.", + "readOnly" : true + } + }, + "xml" : { + "name" : "accessStatus" + } + }, + "AccessStatusEntity" : { + "type" : "object", + "properties" : { + "accessStatus" : { + "$ref" : "#/definitions/AccessStatusDTO" + } + }, + "xml" : { + "name" : "accessStatusEntity" + } + }, + "ActionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32", + "description" : "The action id." + }, + "userIdentity" : { + "type" : "string", + "description" : "The identity of the user that performed the action." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of the source component." + }, + "componentDetails" : { + "description" : "The details of the source component.", + "$ref" : "#/definitions/ComponentDetailsDTO" + }, + "operation" : { + "type" : "string", + "description" : "The operation that was performed." + }, + "actionDetails" : { + "description" : "The details of the action.", + "$ref" : "#/definitions/ActionDetailsDTO" + } + } + }, + "ActionDetailsDTO" : { + "type" : "object" + }, + "ActionEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "action" : { + "$ref" : "#/definitions/ActionDTO" + } + }, + "xml" : { + "name" : "actionEntity" + } + }, + "ActivateControllerServicesEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "activateControllerServicesEntity" + } + }, + "AffectedComponentDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + } + } + }, + "AffectedComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AffectedComponentDTO" + }, + "processGroup" : { + "description" : "The Process Group that the component belongs to", + "$ref" : "#/definitions/ProcessGroupNameDTO" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of component referenced", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + } + }, + "xml" : { + "name" : "affectedComponentEntity" + } + }, + "AllowableValueDTO" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "A human readable value that is allowed for the property descriptor." + }, + "value" : { + "type" : "string", + "description" : "A value that is allowed for the property descriptor." + }, + "description" : { + "type" : "string", + "description" : "A description for this allowable value." + } + } + }, + "AllowableValueEntity" : { + "type" : "object", + "properties" : { + "allowableValue" : { + "$ref" : "#/definitions/AllowableValueDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "AttributeDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The attribute name." + }, + "value" : { + "type" : "string", + "description" : "The attribute value." + }, + "previousValue" : { + "type" : "string", + "description" : "The value of the attribute before the event took place." + } + } + }, + "BannerDTO" : { + "type" : "object", + "properties" : { + "headerText" : { + "type" : "string", + "description" : "The header text." + }, + "footerText" : { + "type" : "string", + "description" : "The footer text." + } + } + }, + "BannerEntity" : { + "type" : "object", + "properties" : { + "banners" : { + "$ref" : "#/definitions/BannerDTO" + } + }, + "xml" : { + "name" : "bannersEntity" + } + }, + "BatchSettingsDTO" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "Bucket" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket." + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "readOnly" : true, + "minimum" : 1 + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "allowBundleRedeploy" : { + "type" : "boolean", + "description" : "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." + }, + "allowPublicRead" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" + }, + "permissions" : { + "description" : "The access that the current user has to this bucket.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "BucketDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The bucket identifier" + }, + "name" : { + "type" : "string", + "description" : "The bucket name" + }, + "description" : { + "type" : "string", + "description" : "The bucket description" + }, + "created" : { + "type" : "integer", + "format" : "int64", + "description" : "The created timestamp of this bucket" + } + } + }, + "BucketEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "bucket" : { + "$ref" : "#/definitions/BucketDTO" + }, + "permissions" : { + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "bucketEntity" + } + }, + "BucketsEntity" : { + "type" : "object", + "properties" : { + "buckets" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BucketEntity" + } + } + }, + "xml" : { + "name" : "bucketsEntity" + } + }, + "BulletinBoardDTO" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins in the bulletin board, that matches the supplied request.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp when this report was generated." + } + } + }, + "BulletinBoardEntity" : { + "type" : "object", + "properties" : { + "bulletinBoard" : { + "$ref" : "#/definitions/BulletinBoardDTO" + } + }, + "xml" : { + "name" : "bulletinBoardEntity" + } + }, + "BulletinDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "description" : "The id of the bulletin." + }, + "nodeAddress" : { + "type" : "string", + "description" : "If clustered, the address of the node from which the bulletin originated." + }, + "category" : { + "type" : "string", + "description" : "The category of this bulletin." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the source component." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "level" : { + "type" : "string", + "description" : "The level of the bulletin." + }, + "message" : { + "type" : "string", + "description" : "The bulletin message." + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + } + } + }, + "BulletinEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "groupId" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + }, + "nodeAddress" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "bulletin" : { + "$ref" : "#/definitions/BulletinDTO" + } + }, + "xml" : { + "name" : "bulletinEntity" + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleDTO" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle." + } + } + }, + "ClusteSummaryEntity" : { + "type" : "object", + "properties" : { + "clusterSummary" : { + "$ref" : "#/definitions/ClusterSummaryDTO" + } + }, + "xml" : { + "name" : "clusterSummaryEntity" + } + }, + "ClusterDTO" : { + "type" : "object", + "properties" : { + "nodes" : { + "type" : "array", + "description" : "The collection of nodes that are part of the cluster.", + "items" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp the report was generated." + } + } + }, + "ClusterEntity" : { + "type" : "object", + "properties" : { + "cluster" : { + "$ref" : "#/definitions/ClusterDTO" + } + }, + "xml" : { + "name" : "clusterEntity" + } + }, + "ClusterSearchResultsEntity" : { + "type" : "object", + "properties" : { + "nodeResults" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NodeSearchResultDTO" + } + } + }, + "xml" : { + "name" : "clusterSearchResultsEntity" + } + }, + "ClusterSummaryDTO" : { + "type" : "object", + "properties" : { + "connectedNodes" : { + "type" : "string", + "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." + }, + "connectedNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes that are currently connected to the cluster" + }, + "totalNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" + }, + "clustered" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is clustered." + }, + "connectedToCluster" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is connected to a cluster." + } + } + }, + "ComponentDetailsDTO" : { + "type" : "object" + }, + "ComponentDifferenceDTO" : { + "type" : "object", + "properties" : { + "componentType" : { + "type" : "string", + "description" : "The type of component" + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the component belongs to" + }, + "differences" : { + "type" : "array", + "description" : "The differences in the component between the two flows", + "items" : { + "$ref" : "#/definitions/DifferenceDTO" + } + } + } + }, + "ComponentHistoryDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component id." + }, + "propertyHistory" : { + "type" : "object", + "description" : "The history for the properties of the component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyHistoryDTO" + } + } + } + }, + "ComponentHistoryEntity" : { + "type" : "object", + "properties" : { + "componentHistory" : { + "$ref" : "#/definitions/ComponentHistoryDTO" + } + }, + "xml" : { + "name" : "componentHistoryEntity" + } + }, + "ComponentReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component." + } + } + }, + "ComponentReferenceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "component" : { + "$ref" : "#/definitions/ComponentReferenceDTO" + } + }, + "xml" : { + "name" : "componentReferenceEntity" + } + }, + "ComponentRestrictionPermissionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "permissions" : { + "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + } + } + }, + "ComponentSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component that matched the search." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the component that matched the search." + }, + "parentGroup" : { + "description" : "The parent group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "versionedGroup" : { + "description" : "The nearest versioned ancestor group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component that matched the search." + }, + "matches" : { + "type" : "array", + "description" : "What matched the search from the component.", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentStateDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component identifier." + }, + "stateDescription" : { + "type" : "string", + "description" : "Description of the state this component persists." + }, + "clusterState" : { + "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", + "$ref" : "#/definitions/StateMapDTO" + }, + "localState" : { + "description" : "The local state for this component.", + "$ref" : "#/definitions/StateMapDTO" + } + } + }, + "ComponentStateEntity" : { + "type" : "object", + "properties" : { + "componentState" : { + "description" : "The component state.", + "$ref" : "#/definitions/ComponentStateDTO" + } + }, + "xml" : { + "name" : "componentStateEntity" + } + }, + "ComponentValidationResultDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "currentlyValid" : { + "type" : "boolean", + "description" : "Whether or not the component is currently valid" + }, + "resultsValid" : { + "type" : "boolean", + "description" : "Whether or not the component will be valid if the Parameter Context is changed" + }, + "resultantValidationErrors" : { + "type" : "array", + "description" : "The validation errors that will apply to the component if the Parameter Context is changed", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentValidationResultEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ComponentValidationResultDTO" + } + }, + "xml" : { + "name" : "componentValidationResultEntity" + } + }, + "ComponentValidationResultsEntity" : { + "type" : "object", + "properties" : { + "validationResults" : { + "type" : "array", + "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", + "items" : { + "$ref" : "#/definitions/ComponentValidationResultEntity" + } + } + }, + "xml" : { + "name" : "componentValidationResults" + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectableDTO" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "running" : { + "type" : "boolean", + "description" : "Reflects the current state of the connectable component." + }, + "transmitting" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." + }, + "exists" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target exists." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "availableRelationships" : { + "type" : "array", + "description" : "The relationships that the source of the connection currently supports.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "How to load balance the data in this Connection across the nodes in the cluster.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "loadBalancePartitionAttribute" : { + "type" : "string", + "description" : "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" + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "loadBalanceStatus" : { + "type" : "string", + "description" : "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.", + "readOnly" : true, + "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] + } + } + }, + "ConnectionEntity" : { + "type" : "object", + "required" : [ "destinationType", "sourceType" ], + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ConnectionDTO" + }, + "status" : { + "description" : "The status of the connection.", + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The identifier of the source of this connection." + }, + "sourceGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the source of this connection." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of component the source connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "destinationId" : { + "type" : "string", + "description" : "The identifier of the destination of this connection." + }, + "destinationGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the destination of this connection." + }, + "destinationType" : { + "type" : "string", + "description" : "The type of component the destination connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + } + }, + "xml" : { + "name" : "connectionEntity" + } + }, + "ConnectionStatisticsDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" + } + } + } + }, + "ConnectionStatisticsEntity" : { + "type" : "object", + "properties" : { + "connectionStatistics" : { + "$ref" : "#/definitions/ConnectionStatisticsDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatisticsEntity" + } + }, + "ConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of queued objects at the next configured interval." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." + }, + "predictionIntervalMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The prediction interval in seconds" + } + } + }, + "ConnectionStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the connection belongs to" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "sourceId" : { + "type" : "string", + "description" : "The ID of the source component" + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component" + }, + "destinationId" : { + "type" : "string", + "description" : "The ID of the destination component" + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination component" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" + } + } + } + }, + "ConnectionStatusEntity" : { + "type" : "object", + "properties" : { + "connectionStatus" : { + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatusEntity" + } + }, + "ConnectionStatusPredictionsSnapshotDTO" : { + "type" : "object", + "properties" : { + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictionIntervalSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the process group the connection belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source of the connection." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source of the connection." + }, + "destinationId" : { + "type" : "string", + "description" : "The id of the destination of the connection." + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination of the connection." + }, + "predictions" : { + "description" : "Predictions, if available, for this connection (null if not available)", + "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have left the connection in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are currently queued in the connection." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that are currently queued in the connection." + }, + "queued" : { + "type" : "string", + "description" : "The total count and size of queued flowfiles formatted." + }, + "queuedSize" : { + "type" : "string", + "description" : "The total size of flowfiles that are queued formatted." + }, + "queuedCount" : { + "type" : "string", + "description" : "The number of flowfiles that are queued, pretty printed." + }, + "percentUseCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "percentUseBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "connectionStatusSnapshot" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ConnectionsEntity" : { + "type" : "object", + "properties" : { + "connections" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } + }, + "xml" : { + "name" : "connectionsEntity" + } + }, + "ControllerBulletinsEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "System level bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "controllerServiceBulletins" : { + "type" : "array", + "description" : "Controller service bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "reportingTaskBulletins" : { + "type" : "array", + "description" : "Reporting task bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerConfigurationDTO" : { + "type" : "object", + "properties" : { + "maxTimerDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of timer driven threads the NiFi has available." + }, + "maxEventDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of event driven threads the NiFi has available." + } + } + }, + "ControllerConfigurationEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/ControllerConfigurationDTO" + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the NiFi." + }, + "name" : { + "type" : "string", + "description" : "The name of the NiFi." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the NiFi." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports contained in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports contained in the NiFi." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports contained in the NiFi." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the NiFi." + }, + "remoteSiteListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "remoteSiteHttpListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "siteToSiteSecure" : { + "type" : "boolean", + "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." + }, + "instanceId" : { + "type" : "string", + "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports available to send data to for the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports available to received data from the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + } + } + }, + "ControllerEntity" : { + "type" : "object", + "properties" : { + "controller" : { + "$ref" : "#/definitions/ControllerDTO" + } + }, + "xml" : { + "name" : "controllerEntity" + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceApiDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "ControllerServiceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the controller service." + }, + "state" : { + "type" : "string", + "description" : "The state of the controller service.", + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the controller service persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the controller service requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the ontroller service has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the controller service has multiple versions available." + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the controller service properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the controller services custom configuration UI if applicable." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "referencingComponents" : { + "type" : "array", + "description" : "All components referencing this controller service.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ControllerServiceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this ControllerService." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ControllerService.", + "readOnly" : true, + "$ref" : "#/definitions/ControllerServiceStatusDTO" + } + }, + "xml" : { + "name" : "controllerServiceEntity" + } + }, + "ControllerServiceReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "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." + }, + "id" : { + "type" : "string", + "description" : "The id of the component referencing a controller service." + }, + "name" : { + "type" : "string", + "description" : "The name of the component referencing a controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the component referencing a controller service in simple Java class name format without package name." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the component properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "referenceType" : { + "type" : "string", + "description" : "The type of reference this is.", + "enum" : [ "Processor", "ControllerService", "ReportingTask" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "referenceCycle" : { + "type" : "boolean", + "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." + }, + "referencingComponents" : { + "type" : "array", + "description" : "If the referencing component represents a controller service, these are the components that reference it.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + } + }, + "ControllerServiceReferencingComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentEntity" + } + }, + "ControllerServiceReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "controllerServiceReferencingComponents" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentsEntity" + } + }, + "ControllerServiceRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ControllerService.", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ControllerServiceStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ControllerService", + "readOnly" : true, + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ControllerServiceTypesEntity" : { + "type" : "object", + "properties" : { + "controllerServiceTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "controllerServiceTypesEntity" + } + }, + "ControllerServicesEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "controllerServices" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } + }, + "xml" : { + "name" : "controllerServicesEntity" + } + }, + "ControllerStatusDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads in the NiFi." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of terminated threads in the NiFi." + }, + "queued" : { + "type" : "string", + "description" : "The number of flowfiles queued in the NiFi." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles queued across the entire flow" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles queued across the entire flow" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the NiFi." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the NiFi." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the NiFi." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the NiFi." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the NiFi." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." + } + } + }, + "ControllerStatusEntity" : { + "type" : "object", + "properties" : { + "controllerStatus" : { + "$ref" : "#/definitions/ControllerStatusDTO" + } + }, + "xml" : { + "name" : "controllerStatusEntity" + } + }, + "CopySnippetRequestEntity" : { + "type" : "object", + "properties" : { + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "CounterDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the counter." + }, + "context" : { + "type" : "string", + "description" : "The context of the counter." + }, + "name" : { + "type" : "string", + "description" : "The name of the counter." + }, + "valueCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The value count." + }, + "value" : { + "type" : "string", + "description" : "The value of the counter." + } + } + }, + "CounterEntity" : { + "type" : "object", + "properties" : { + "counter" : { + "$ref" : "#/definitions/CounterDTO" + } + }, + "xml" : { + "name" : "counterEntity" + } + }, + "CountersDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/CountersSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeCountersSnapshotDTO" + } + } + } + }, + "CountersEntity" : { + "type" : "object", + "properties" : { + "counters" : { + "$ref" : "#/definitions/CountersDTO" + } + }, + "xml" : { + "name" : "countersEntity" + } + }, + "CountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "counters" : { + "type" : "array", + "description" : "All counters in the NiFi.", + "items" : { + "$ref" : "#/definitions/CounterDTO" + } + } + } + }, + "CreateActiveRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The Process Group ID that this active request will update" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createActiveRequestEntity" + } + }, + "CreateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createTemplateRequestEntity" + } + }, + "CurrentUserEntity" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity being serialized." + }, + "anonymous" : { + "type" : "boolean", + "description" : "Whether the current user is anonymous." + }, + "provenancePermissions" : { + "description" : "Permissions for querying provenance.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "countersPermissions" : { + "description" : "Permissions for accessing counters.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "tenantsPermissions" : { + "description" : "Permissions for accessing tenants.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "controllerPermissions" : { + "description" : "Permissions for accessing the controller.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "policiesPermissions" : { + "description" : "Permissions for accessing the policies.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "systemPermissions" : { + "description" : "Permissions for accessing system.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "parameterContextPermissions" : { + "description" : "Permissions for accessing parameter contexts.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "restrictedComponentsPermissions" : { + "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "componentRestrictionPermissions" : { + "type" : "array", + "description" : "Permissions for specific component restrictions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" + } + }, + "canVersionFlows" : { + "type" : "boolean", + "description" : "Whether the current user can version flows." + } + }, + "xml" : { + "name" : "currentEntity" + } + }, + "DifferenceDTO" : { + "type" : "object", + "properties" : { + "differenceType" : { + "type" : "string", + "description" : "The type of difference" + }, + "difference" : { + "type" : "string", + "description" : "Description of the difference" + } + } + }, + "DimensionsDTO" : { + "type" : "object", + "properties" : { + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + } + } + }, + "DocumentedTypeDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the type." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "If this type represents a ControllerService, this lists the APIs it implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the type." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether this type is restricted." + }, + "usageRestriction" : { + "type" : "string", + "description" : "The optional description of why the usage of this component is restricted." + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExplicitRestrictionDTO" + } + }, + "deprecationReason" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted." + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "DropRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this drop request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this drop request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this drop request failed." + }, + "currentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files currently queued." + }, + "currentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files currently queued in bytes." + }, + "current" : { + "type" : "string", + "description" : "The count and size of flow files currently queued." + }, + "originalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files to be dropped as a result of this request." + }, + "originalSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files to be dropped as a result of this request in bytes." + }, + "original" : { + "type" : "string", + "description" : "The count and size of flow files to be dropped as a result of this request." + }, + "droppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files that have been dropped thus far." + }, + "droppedSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files that have been dropped thus far in bytes." + }, + "dropped" : { + "type" : "string", + "description" : "The count and size of flow files that have been dropped thus far." + }, + "state" : { + "type" : "string", + "description" : "The current state of the drop request." + } + } + }, + "DropRequestEntity" : { + "type" : "object", + "properties" : { + "dropRequest" : { + "$ref" : "#/definitions/DropRequestDTO" + } + }, + "xml" : { + "name" : "dropRequestEntity" + } + }, + "ExplicitRestrictionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "explanation" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted for this required permission." + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "FlowBreadcrumbDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The id of the group." + }, + "versionControlInformation" : { + "description" : "The process group version control information or null if not version controlled.", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "FlowBreadcrumbEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this ancestor ProcessGroup." + }, + "permissions" : { + "description" : "The permissions for this ancestor ProcessGroup.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "breadcrumb" : { + "description" : "This breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbDTO" + }, + "parentBreadcrumb" : { + "description" : "The parent breadcrumb for this breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowComparisonEntity" : { + "type" : "object", + "properties" : { + "componentDifferences" : { + "type" : "array", + "description" : "The list of differences for each component in the flow that is not the same between the two flows", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceDTO" + } + } + }, + "xml" : { + "name" : "flowComparisonEntity" + } + }, + "FlowConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi supports configurable users and groups.", + "readOnly" : true + }, + "autoRefreshIntervalSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "The interval in seconds between the automatic NiFi refresh requests.", + "readOnly" : true + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the system." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The default back pressure object threshold." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The default back pressure data size threshold." + } + } + }, + "FlowConfigurationEntity" : { + "type" : "object", + "properties" : { + "flowConfiguration" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/FlowConfigurationDTO" + } + }, + "xml" : { + "name" : "flowConfigurationEntity" + } + }, + "FlowDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + } + }, + "FlowEntity" : { + "type" : "object", + "properties" : { + "flow" : { + "$ref" : "#/definitions/FlowDTO" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowFileDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "attributes" : { + "type" : "object", + "description" : "The FlowFile attributes.", + "additionalProperties" : { + "type" : "string" + } + }, + "contentClaimSection" : { + "type" : "string", + "description" : "The section in which the content claim lives." + }, + "contentClaimContainer" : { + "type" : "string", + "description" : "The container in which the content claim lives." + }, + "contentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the content claim." + }, + "contentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the content claim where the flowfile's content begins." + }, + "contentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the content claim formatted." + }, + "contentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the content claim in bytes." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowFileEntity" : { + "type" : "object", + "properties" : { + "flowFile" : { + "$ref" : "#/definitions/FlowFileDTO" + } + }, + "xml" : { + "name" : "flowFileEntity" + } + }, + "FlowFileSummaryDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowSnippetDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupDTO" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorDTO" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDTO" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The controller services in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceDTO" + } + } + } + }, + "FunnelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + } + } + }, + "FunnelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "xml" : { + "name" : "funnelEntity" + } + }, + "FunnelsEntity" : { + "type" : "object", + "properties" : { + "funnels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + }, + "xml" : { + "name" : "funnelsEntity" + } + }, + "GarbageCollectionDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the garbage collector." + }, + "collectionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of times garbage collection has run." + }, + "collectionTime" : { + "type" : "string", + "description" : "The total amount of time spent garbage collecting." + }, + "collectionMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of milliseconds spent garbage collecting." + } + } + }, + "HistoryDTO" : { + "type" : "object", + "properties" : { + "total" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of number of actions that matched the search criteria.." + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "actions" : { + "type" : "array", + "description" : "The actions.", + "items" : { + "$ref" : "#/definitions/ActionEntity" + } + } + } + }, + "HistoryEntity" : { + "type" : "object", + "properties" : { + "history" : { + "$ref" : "#/definitions/HistoryDTO" + } + }, + "xml" : { + "name" : "historyEntity" + } + }, + "InputPortsEntity" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "inputPortsEntity" + } + }, + "InstantiateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "templateId" : { + "type" : "string", + "description" : "The identifier of the template." + }, + "encodingVersion" : { + "type" : "string", + "description" : "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." + }, + "snippet" : { + "description" : "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.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "instantiateTemplateRequestEntity" + } + }, + "JaxbLink" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "format" : "uri", + "xml" : { + "attribute" : true + }, + "description" : "The href for the link" + }, + "params" : { + "type" : "object", + "description" : "The params for the link", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "dimensions" : { + "$ref" : "#/definitions/DimensionsDTO" + }, + "component" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "xml" : { + "name" : "labelEntity" + } + }, + "LabelsEntity" : { + "type" : "object", + "properties" : { + "labels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + } + }, + "xml" : { + "name" : "labelsEntity" + } + }, + "LineageDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this lineage query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this lineage query for later retrieval and deletion." + }, + "submissionTime" : { + "type" : "string", + "description" : "When the lineage query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "When the lineage query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percent complete for the lineage query." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the lineage query has finished." + }, + "request" : { + "description" : "The initial lineage result.", + "$ref" : "#/definitions/LineageRequestDTO" + }, + "results" : { + "description" : "The results of the lineage query.", + "$ref" : "#/definitions/LineageResultsDTO" + } + } + }, + "LineageEntity" : { + "type" : "object", + "properties" : { + "lineage" : { + "$ref" : "#/definitions/LineageDTO" + } + }, + "xml" : { + "name" : "lineageEntity" + } + }, + "LineageRequestDTO" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lineageRequestType" : { + "type" : "string", + "description" : "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.", + "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] + }, + "uuid" : { + "type" : "string", + "description" : "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." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this lineage originated if clustered." + } + } + }, + "LineageResultsDTO" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while generating the lineage.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "nodes" : { + "type" : "array", + "description" : "The nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceNodeDTO" + } + }, + "links" : { + "type" : "array", + "description" : "The links between the nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceLinkDTO" + } + } + } + }, + "ListingRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this listing request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this listing request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this listing request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this listing request failed." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of FlowFileSummary objects to return" + }, + "state" : { + "type" : "string", + "description" : "The current state of the listing request." + }, + "queueSize" : { + "description" : "The size of the queue", + "$ref" : "#/definitions/QueueSizeDTO" + }, + "flowFileSummaries" : { + "type" : "array", + "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", + "items" : { + "$ref" : "#/definitions/FlowFileSummaryDTO" + } + }, + "sourceRunning" : { + "type" : "boolean", + "description" : "Whether the source of the connection is running" + }, + "destinationRunning" : { + "type" : "boolean", + "description" : "Whether the destination of the connection is running" + } + } + }, + "ListingRequestEntity" : { + "type" : "object", + "properties" : { + "listingRequest" : { + "$ref" : "#/definitions/ListingRequestDTO" + } + }, + "xml" : { + "name" : "listingRequestEntity" + } + }, + "NodeConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statisticsSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + } + } + }, + "NodeConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + } + } + }, + "NodeCountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The counters from the node.", + "$ref" : "#/definitions/CountersSnapshotDTO" + } + } + }, + "NodeDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node.", + "readOnly" : true + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address.", + "readOnly" : true + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The node's status." + }, + "heartbeat" : { + "type" : "string", + "description" : "the time of the nodes's last heartbeat.", + "readOnly" : true + }, + "connectionRequested" : { + "type" : "string", + "description" : "The time of the node's last connection request.", + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "The roles of this node.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active threads for the NiFi on the node.", + "readOnly" : true + }, + "queued" : { + "type" : "string", + "description" : "The queue the NiFi on the node.", + "readOnly" : true + }, + "events" : { + "type" : "array", + "description" : "The node's events.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/NodeEventDTO" + } + }, + "nodeStartTime" : { + "type" : "string", + "description" : "The time at which this Node was last refreshed.", + "readOnly" : true + } + } + }, + "NodeEntity" : { + "type" : "object", + "properties" : { + "node" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "xml" : { + "name" : "nodeEntity" + } + }, + "NodeEventDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node event." + }, + "category" : { + "type" : "string", + "description" : "The category of the node event." + }, + "message" : { + "type" : "string", + "description" : "The message in the node event." + } + } + }, + "NodePortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The port status snapshot from the node.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + } + } + }, + "NodeProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The process group status snapshot from the node.", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The processor status snapshot from the node.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + } + } + }, + "NodeRemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The remote process group status snapshot from the node.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node that matched the search." + }, + "address" : { + "type" : "string", + "description" : "The address of the node that matched the search." + } + } + }, + "NodeStatusSnapshotsDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node." + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address." + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests." + }, + "statusSnapshots" : { + "type" : "array", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + } + } + }, + "NodeSystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The System Diagnostics snapshot from the node.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + } + } + }, + "OutputPortsEntity" : { + "type" : "object", + "properties" : { + "outputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "outputPortsEntity" + } + }, + "ParameterContextDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The Name of the Parameter Context." + }, + "description" : { + "type" : "string", + "description" : "The Description of the Parameter Context." + }, + "parameters" : { + "type" : "array", + "description" : "The Parameters for the Parameter Context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterEntity" + } + }, + "boundProcessGroups" : { + "type" : "array", + "description" : "The Process Groups that are bound to this Parameter Context", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "id" : { + "type" : "string", + "description" : "The ID the Parameter Context.", + "readOnly" : true + } + } + }, + "ParameterContextEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The Parameter Context", + "$ref" : "#/definitions/ParameterContextDTO" + } + }, + "xml" : { + "name" : "parameterContextEntity" + } + }, + "ParameterContextReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Parameter Context" + }, + "name" : { + "type" : "string", + "description" : "The name of the Parameter Context" + } + } + }, + "ParameterContextReferenceEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "component" : { + "$ref" : "#/definitions/ParameterContextReferenceDTO" + } + }, + "xml" : { + "name" : "parameterContextReferenceEntity" + } + }, + "ParameterContextUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextUpdateStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "$ref" : "#/definitions/ParameterContextDTO" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterContextUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "parameterContextRevision" : { + "description" : "The Revision of the Parameter Context", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" + } + }, + "xml" : { + "name" : "parameterContextUpdateRequestEntity" + } + }, + "ParameterContextUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextValidationRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextValidationStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on.", + "$ref" : "#/definitions/ParameterContextDTO" + }, + "componentValidationResults" : { + "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", + "readOnly" : true, + "$ref" : "#/definitions/ComponentValidationResultsEntity" + } + } + }, + "ParameterContextValidationRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextValidationRequestDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "parameterContextValidationRequestEntity" + } + }, + "ParameterContextValidationStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextsEntity" : { + "type" : "object", + "properties" : { + "parameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system.", + "readOnly" : true + } + }, + "xml" : { + "name" : "parameterContexts" + } + }, + "ParameterDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the Parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the Parameter" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the Parameter" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing this Parameter", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterEntity" : { + "type" : "object", + "properties" : { + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "parameter" : { + "description" : "The parameter information", + "$ref" : "#/definitions/ParameterDTO" + } + }, + "xml" : { + "name" : "parameterEntity" + } + }, + "PeerDTO" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "The hostname of this peer." + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "The port number of this peer." + }, + "secure" : { + "type" : "boolean", + "description" : "Returns if this peer connection is secure." + }, + "flowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flowFiles this peer holds." + } + } + }, + "PeersEntity" : { + "type" : "object", + "properties" : { + "peers" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PeerDTO" + } + } + }, + "xml" : { + "name" : "peersEntity" + } + }, + "Permissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + } + } + }, + "PermissionsDTO" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + } + }, + "PortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the port." + }, + "state" : { + "type" : "string", + "description" : "The state of the port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "transmitting" : { + "type" : "boolean", + "description" : "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." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "userAccessControl" : { + "type" : "array", + "description" : "The users that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "groupAccessControl" : { + "type" : "array", + "description" : "The user groups that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + } + } + }, + "PortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/PortDTO" + }, + "status" : { + "description" : "The status of the port.", + "$ref" : "#/definitions/PortStatusDTO" + }, + "portType" : { + "type" : "string" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + } + }, + "xml" : { + "name" : "portEntity" + } + }, + "PortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "PortStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodePortStatusSnapshotDTO" + } + } + } + }, + "PortStatusEntity" : { + "type" : "object", + "properties" : { + "portStatus" : { + "$ref" : "#/definitions/PortStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "portStatusEntity" + } + }, + "PortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for the port." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been processed in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have been processed in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + } + } + }, + "PortStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "portStatusSnapshot" : { + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "PositionDTO" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "PreviousValueDTO" : { + "type" : "object", + "properties" : { + "previousValue" : { + "type" : "string", + "description" : "The previous value." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the value was modified." + }, + "userIdentity" : { + "type" : "string", + "description" : "The user who changed the previous value." + } + } + }, + "PrioritizerTypesEntity" : { + "type" : "object", + "properties" : { + "prioritizerTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "prioritizerTypesEntity" + } + }, + "ProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the process group." + }, + "variables" : { + "type" : "object", + "description" : "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.", + "readOnly" : true, + "additionalProperties" : { + "type" : "string" + } + }, + "versionControlInformation" : { + "description" : "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", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "parameterContext" : { + "description" : "The Parameter Context that this Process Group is bound to.", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "contents" : { + "description" : "The contents of this process group.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + } + }, + "ProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessGroupDTO" + }, + "status" : { + "description" : "The status of the process group.", + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "versionedFlowSnapshot" : { + "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupEntity" + } + }, + "ProcessGroupFlowDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "breadcrumb" : { + "description" : "The breadcrumb of the process group.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + }, + "flow" : { + "description" : "The flow structure starting at this Process Group.", + "$ref" : "#/definitions/FlowDTO" + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The time the flow for the process group was last refreshed." + } + } + }, + "ProcessGroupFlowEntity" : { + "type" : "object", + "properties" : { + "permissions" : { + "description" : "The access policy for this process group.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "processGroupFlow" : { + "$ref" : "#/definitions/ProcessGroupFlowDTO" + } + }, + "xml" : { + "name" : "processGroupFlowEntity" + } + }, + "ProcessGroupNameDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" + } + } + }, + "ProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "The aggregate status of all nodes in the cluster", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" + } + } + } + }, + "ProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "processGroupStatus" : { + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupStatusEntity" + } + }, + "ProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "name" : { + "type" : "string", + "description" : "The name of this process group." + }, + "connectionStatusSnapshots" : { + "type" : "array", + "description" : "The status of all connections in the process group.", + "items" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" + } + }, + "processorStatusSnapshots" : { + "type" : "array", + "description" : "The status of all processors in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" + } + }, + "processGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all process groups in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" + } + }, + "remoteProcessGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all remote process groups in the process group.", + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" + } + }, + "inputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all input ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "outputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all output ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are queued up in this ProcessGroup right now" + }, + "queued" : { + "type" : "string", + "description" : "The count/size that is queued in the the process group." + }, + "queuedCount" : { + "type" : "string", + "description" : "The count that is queued for the process group." + }, + "queuedSize" : { + "type" : "string", + "description" : "The size that is queued for the process group." + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The output count/size for the process group in the last 5 minutes." + }, + "flowFilesTransferred" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" + }, + "bytesTransferred" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" + }, + "transferred" : { + "type" : "string", + "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "received" : { + "type" : "string", + "description" : "The count/size sent to the process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "sent" : { + "type" : "string", + "description" : "The count/size sent from this process group in the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for this process group." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the process group." + } + } + }, + "ProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "processGroupStatusSnapshot" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "processGroupsEntity" + } + }, + "ProcessorConfigDTO" : { + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "Descriptors for the processor's properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the processor." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the processor's custom configuration UI if applicable." + }, + "lossTolerant" : { + "type" : "boolean", + "description" : "Whether the processor is loss tolerant." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "defaultConcurrentTasks" : { + "type" : "object", + "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "ProcessorDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the processor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the processor", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "style" : { + "type" : "object", + "description" : "Styles for the processor (background-color : #eee).", + "additionalProperties" : { + "type" : "string" + } + }, + "relationships" : { + "type" : "array", + "description" : "The available relationships that the processor currently supports.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/RelationshipDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the processor." + }, + "supportsParallelProcessing" : { + "type" : "boolean", + "description" : "Whether the processor supports parallel processing." + }, + "supportsEventDriven" : { + "type" : "boolean", + "description" : "Whether the processor supports event driven scheduling." + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether the processor supports batching. This makes the run duration settings available." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the processor persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the processor requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the processor has been deprecated." + }, + "executionNodeRestricted" : { + "type" : "boolean", + "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the processor has multiple versions available." + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "config" : { + "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", + "$ref" : "#/definitions/ProcessorConfigDTO" + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ProcessorEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessorDTO" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "status" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "processorEntity" + } + }, + "ProcessorRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Processor.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the Processor" + }, + "type" : { + "type" : "string", + "description" : "The type of the Processor" + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the Processor", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" + } + } + } + }, + "ProcessorStatusEntity" : { + "type" : "object", + "properties" : { + "processorStatus" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processorStatusEntity" + } + }, + "ProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group to which the processor belongs." + }, + "name" : { + "type" : "string", + "description" : "The name of the prcessor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "runStatus" : { + "type" : "string", + "description" : "The state of the processor.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute.", + "enum" : [ "ALL", "PRIMARY" ] + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by this Processor in the last 5 mintues" + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by this Processor in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "taskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of times this Processor has run in the last 5 minutes" + }, + "tasksDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" + }, + "tasks" : { + "type" : "string", + "description" : "The total number of task this connectable has completed over the last 5 minutes." + }, + "tasksDuration" : { + "type" : "string", + "description" : "The total duration of all tasks for this connectable over the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently executing in the processor." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the processor." + } + } + }, + "ProcessorStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "processorStatusSnapshot" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorTypesEntity" : { + "type" : "object", + "properties" : { + "processorTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "processorTypesEntity" + } + }, + "ProcessorsEntity" : { + "type" : "object", + "properties" : { + "processors" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } + }, + "xml" : { + "name" : "processorsEntity" + } + }, + "PropertyDescriptorDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name for the property." + }, + "displayName" : { + "type" : "string", + "description" : "The human readable name for the property." + }, + "description" : { + "type" : "string", + "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value for the property." + }, + "allowableValues" : { + "type" : "array", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "items" : { + "$ref" : "#/definitions/AllowableValueEntity" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether the property is required." + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether the property is sensitive and protected whenever stored or represented." + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether the property is dynamic (user-defined)." + }, + "supportsEl" : { + "type" : "boolean", + "description" : "Whether the property supports expression language." + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "Scope of the Expression Language evaluation for the property." + }, + "identifiesControllerService" : { + "type" : "string", + "description" : "If the property identifies a controller service this returns the fully qualified type." + }, + "identifiesControllerServiceBundle" : { + "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "PropertyDescriptorEntity" : { + "type" : "object", + "properties" : { + "propertyDescriptor" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "xml" : { + "name" : "propertyDescriptor" + } + }, + "PropertyHistoryDTO" : { + "type" : "object", + "properties" : { + "previousValues" : { + "type" : "array", + "description" : "Previous values for a given property.", + "items" : { + "$ref" : "#/definitions/PreviousValueDTO" + } + } + } + }, + "ProvenanceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the provenance query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "The timestamp when the query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "request" : { + "description" : "The provenance request.", + "$ref" : "#/definitions/ProvenanceRequestDTO" + }, + "results" : { + "description" : "The provenance results.", + "$ref" : "#/definitions/ProvenanceResultsDTO" + } + } + }, + "ProvenanceEntity" : { + "type" : "object", + "properties" : { + "provenance" : { + "$ref" : "#/definitions/ProvenanceDTO" + } + }, + "xml" : { + "name" : "provenanceEntity" + } + }, + "ProvenanceEventDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The event uuid." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id. This is a one up number thats unique per node." + }, + "eventTime" : { + "type" : "string", + "description" : "The timestamp of the event." + }, + "eventDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The event duration in milliseconds." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The duration since the lineage began, in milliseconds." + }, + "eventType" : { + "type" : "string", + "description" : "The type of the event." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile for the event." + }, + "fileSize" : { + "type" : "string", + "description" : "The size of the flowfile for the event." + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the flowfile in bytes for the event." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the event originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the event originated." + }, + "groupId" : { + "type" : "string", + "description" : "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." + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component that generated the event." + }, + "componentType" : { + "type" : "string", + "description" : "The type of the component that generated the event." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component that generated the event." + }, + "sourceSystemFlowFileId" : { + "type" : "string", + "description" : "The source system flowfile id." + }, + "alternateIdentifierUri" : { + "type" : "string", + "description" : "The alternate identifier uri for the fileflow for the event." + }, + "attributes" : { + "type" : "array", + "description" : "The attributes of the flowfile for the event.", + "items" : { + "$ref" : "#/definitions/AttributeDTO" + } + }, + "parentUuids" : { + "type" : "array", + "description" : "The parent uuids for the event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The child uuids for the event.", + "items" : { + "type" : "string" + } + }, + "transitUri" : { + "type" : "string", + "description" : "The source/destination system uri if the event was a RECEIVE/SEND." + }, + "relationship" : { + "type" : "string", + "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." + }, + "details" : { + "type" : "string", + "description" : "The event details." + }, + "contentEqual" : { + "type" : "boolean", + "description" : "Whether the input and output content claim is the same." + }, + "inputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the input content is still available." + }, + "inputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the input content claim lives." + }, + "inputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the input content claim lives." + }, + "inputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the input content claim." + }, + "inputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the input content claim where the flowfiles content begins." + }, + "inputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the input content claim formatted." + }, + "inputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the intput content claim in bytes." + }, + "outputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the output content is still available." + }, + "outputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the output content claim lives." + }, + "outputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the output content claim lives." + }, + "outputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the output content claim." + }, + "outputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the output content claim where the flowfiles content begins." + }, + "outputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the output content claim formatted." + }, + "outputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the output content claim in bytes." + }, + "replayAvailable" : { + "type" : "boolean", + "description" : "Whether or not replay is available." + }, + "replayExplanation" : { + "type" : "string", + "description" : "Explanation as to why replay is unavailable." + }, + "sourceConnectionIdentifier" : { + "type" : "string", + "description" : "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." + } + } + }, + "ProvenanceEventEntity" : { + "type" : "object", + "properties" : { + "provenanceEvent" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "xml" : { + "name" : "provenanceEventEntity" + } + }, + "ProvenanceLinkDTO" : { + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "The source node id of the link." + }, + "targetId" : { + "type" : "string", + "description" : "The target node id of the link." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The flowfile uuid that traversed the link." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the link (based on the destination)." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of this link in milliseconds." + } + } + }, + "ProvenanceNodeDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile associated with the provenance event." + }, + "parentUuids" : { + "type" : "array", + "description" : "The uuid of the parent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The uuid of the childrent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "clusterNodeIdentifier" : { + "type" : "string", + "description" : "The identifier of the node that this event/flowfile originated from." + }, + "type" : { + "type" : "string", + "description" : "The type of the node.", + "enum" : [ "FLOWFILE", "EVENT" ] + }, + "eventType" : { + "type" : "string", + "description" : "If the type is EVENT, this is the type of event." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the node in milliseconds." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node formatted." + } + } + }, + "ProvenanceOptionsDTO" : { + "type" : "object", + "properties" : { + "searchableFields" : { + "type" : "array", + "description" : "The available searchable field for the NiFi.", + "items" : { + "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" + } + } + } + }, + "ProvenanceOptionsEntity" : { + "type" : "object", + "properties" : { + "provenanceOptions" : { + "$ref" : "#/definitions/ProvenanceOptionsDTO" + } + }, + "xml" : { + "name" : "provenanceOptionsEntity" + } + }, + "ProvenanceRequestDTO" : { + "type" : "object", + "properties" : { + "searchTerms" : { + "type" : "object", + "description" : "The search terms used to perform the search.", + "additionalProperties" : { + "type" : "string" + } + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node in the cluster where this provenance originated." + }, + "startDate" : { + "type" : "string", + "description" : "The earliest event time to include in the query." + }, + "endDate" : { + "type" : "string", + "description" : "The latest event time to include in the query." + }, + "minimumFileSize" : { + "type" : "string", + "description" : "The minimum file size to include in the query." + }, + "maximumFileSize" : { + "type" : "string", + "description" : "The maximum file size to include in the query." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of results to include." + }, + "summarize" : { + "type" : "boolean", + "description" : "Whether or not to summarize provenance events returned. This property is false by default." + }, + "incrementalResults" : { + "type" : "boolean", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." + } + } + }, + "ProvenanceResultsDTO" : { + "type" : "object", + "properties" : { + "provenanceEvents" : { + "type" : "array", + "description" : "The provenance events that matched the search criteria.", + "items" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "total" : { + "type" : "string", + "description" : "The total number of results formatted." + }, + "totalCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of results." + }, + "generated" : { + "type" : "string", + "description" : "Then the search was performed." + }, + "oldestEvent" : { + "type" : "string", + "description" : "The oldest event available in the provenance repository." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the server that's used for event time." + }, + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while performing the provenance request.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ProvenanceSearchableFieldDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the searchable field." + }, + "field" : { + "type" : "string", + "description" : "The searchable field." + }, + "label" : { + "type" : "string", + "description" : "The label for the searchable field." + }, + "type" : { + "type" : "string", + "description" : "The type of the searchable field." + } + } + }, + "QueueSizeDTO" : { + "type" : "object", + "properties" : { + "byteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of objects in a queue." + }, + "objectCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The count of objects in a queue." + } + } + }, + "RegistryClientEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RegistryDTO" + } + }, + "xml" : { + "name" : "registryClientEntity" + } + }, + "RegistryClientsEntity" : { + "type" : "object", + "properties" : { + "registries" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } + }, + "xml" : { + "name" : "registryClientsEntity" + } + }, + "RegistryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The registry identifier" + }, + "name" : { + "type" : "string", + "description" : "The registry name" + }, + "description" : { + "type" : "string", + "description" : "The registry description" + }, + "uri" : { + "type" : "string", + "description" : "The registry URI" + } + } + }, + "RelationshipDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The relationship name." + }, + "description" : { + "type" : "string", + "description" : "The relationship description." + }, + "autoTerminate" : { + "type" : "boolean", + "description" : "Whether or not flowfiles sent to this relationship should auto terminate." + } + } + }, + "RemotePortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the RemotePort.", + "enum" : [ "TRANSMITTING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupContentsDTO" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "description" : "The input ports to which data can be sent.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports from which data can be retrieved.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + } + } + }, + "RemoteProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "targetUri" : { + "type" : "string", + "description" : "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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "targetSecure" : { + "type" : "boolean", + "description" : "Whether the target is running securely." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the remote process group." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string" + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "authorizationIssues" : { + "type" : "array", + "description" : "Any remote authorization issues for the remote process group.", + "items" : { + "type" : "string" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote process group is actively transmitting." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "activeRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote input ports." + }, + "inactiveRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote input ports." + }, + "activeRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote output ports." + }, + "inactiveRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote output ports." + }, + "flowRefreshed" : { + "type" : "string", + "description" : "The timestamp when this remote process group was last refreshed." + }, + "contents" : { + "description" : "The contents of the remote process group. Will contain available input/output ports.", + "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" + } + } + }, + "RemoteProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + }, + "status" : { + "description" : "The status of the remote process group.", + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupEntity" + } + }, + "RemoteProcessGroupPortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "targetId" : { + "type" : "string", + "description" : "The id of the target port." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the target port." + }, + "comments" : { + "type" : "string", + "description" : "The comments as configured on the target port." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote port is configured for transmission." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "exists" : { + "type" : "boolean", + "description" : "Whether the target port exists." + }, + "targetRunning" : { + "type" : "boolean", + "description" : "Whether the target port is running." + }, + "connected" : { + "type" : "boolean", + "description" : "Whether the port has either an incoming or outgoing connection." + }, + "batchSettings" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSettingsDTO" + } + } + }, + "RemoteProcessGroupPortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "remoteProcessGroupPort" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupPortEntity" + } + }, + "RemoteProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" + } + } + } + }, + "RemoteProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroupStatus" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "remoteProcessGroupStatusEntity" + } + }, + "RemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group the remote process group resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the remote process group." + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." + }, + "sent" : { + "type" : "string", + "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." + }, + "received" : { + "type" : "string", + "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." + } + } + }, + "RemoteProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "remoteProcessGroupStatusSnapshot" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "remoteProcessGroupsEntity" + } + }, + "ReportingTaskDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the reporting task." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the reporting task." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the reporting task.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "comments" : { + "type" : "string", + "description" : "The comments of the reporting task." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the reporting task persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the reporting task requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the reporting task has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the reporting task has multiple versions available." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "The default scheduling period for the different scheduling strategies.", + "additionalProperties" : { + "type" : "string" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the reporting task.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the reporting tasks properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the reporting task." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the reporting task." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ReportingTaskEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ReportingTaskDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ReportingTask.", + "readOnly" : true, + "$ref" : "#/definitions/ReportingTaskStatusDTO" + } + }, + "xml" : { + "name" : "reportingTaskEntity" + } + }, + "ReportingTaskRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ReportingTask.", + "enum" : [ "RUNNING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ReportingTaskStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ReportingTask", + "readOnly" : true, + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ReportingTaskTypesEntity" : { + "type" : "object", + "properties" : { + "reportingTaskTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "reportingTaskTypesEntity" + } + }, + "ReportingTasksEntity" : { + "type" : "object", + "properties" : { + "reportingTasks" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } + }, + "xml" : { + "name" : "reportingTasksEntity" + } + }, + "RequiredPermissionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The required sub-permission necessary for this restriction." + }, + "label" : { + "type" : "string", + "description" : "The label for the required sub-permission necessary for this restriction." + } + } + }, + "ResourceDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource." + }, + "name" : { + "type" : "string", + "description" : "The name of the resource." + } + } + }, + "ResourcesEntity" : { + "type" : "object", + "properties" : { + "resources" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ResourceDTO" + } + } + }, + "xml" : { + "name" : "resourcesEntity" + } + }, + "RevisionDTO" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "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" + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the flow.", + "readOnly" : true + } + } + }, + "ScheduleComponentsEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "scheduleComponentEntity" + } + }, + "SearchResultGroupDTO" : { + "type" : "object", + "required" : [ "id" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The name of the group." + } + } + }, + "SearchResultsDTO" : { + "type" : "object", + "properties" : { + "processorResults" : { + "type" : "array", + "description" : "The processors that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "connectionResults" : { + "type" : "array", + "description" : "The connections that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "processGroupResults" : { + "type" : "array", + "description" : "The process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "inputPortResults" : { + "type" : "array", + "description" : "The input ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "outputPortResults" : { + "type" : "array", + "description" : "The output ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "remoteProcessGroupResults" : { + "type" : "array", + "description" : "The remote process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "funnelResults" : { + "type" : "array", + "description" : "The funnels that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterContextResults" : { + "type" : "array", + "description" : "The parameter contexts that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterResults" : { + "type" : "array", + "description" : "The parameters that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + } + } + }, + "SearchResultsEntity" : { + "type" : "object", + "properties" : { + "searchResultsDTO" : { + "$ref" : "#/definitions/SearchResultsDTO" + } + }, + "xml" : { + "name" : "searchResultsEntity" + } + }, + "SnippetDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the snippet." + }, + "uri" : { + "type" : "string", + "description" : "The URI of the snippet." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The group id for the components in the snippet." + }, + "processGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "remoteProcessGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "processors" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "inputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "outputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "connections" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "labels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "funnels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + } + } + }, + "SnippetEntity" : { + "type" : "object", + "properties" : { + "snippet" : { + "description" : "The snippet.", + "$ref" : "#/definitions/SnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "snippetEntity" + } + }, + "StartVersionControlRequestEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "startVersionControlRequestEntity" + } + }, + "StateEntryDTO" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string", + "description" : "The key for this state." + }, + "value" : { + "type" : "string", + "description" : "The value for this state." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the state originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the state originated." + } + } + }, + "StateMapDTO" : { + "type" : "object", + "properties" : { + "scope" : { + "type" : "string", + "description" : "The scope of this StateMap." + }, + "totalEntryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." + }, + "state" : { + "type" : "array", + "description" : "The state.", + "items" : { + "$ref" : "#/definitions/StateEntryDTO" + } + } + } + }, + "StatusDescriptorDTO" : { + "type" : "object", + "properties" : { + "field" : { + "type" : "string", + "description" : "The name of the status field." + }, + "label" : { + "type" : "string", + "description" : "The label for the status field." + }, + "description" : { + "type" : "string", + "description" : "The description of the status field." + }, + "formatter" : { + "type" : "string", + "description" : "The formatter for the status descriptor." + } + } + }, + "StatusHistoryDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When the status history was generated." + }, + "componentDetails" : { + "type" : "object", + "description" : "A Map of key/value pairs that describe the component that the status history belongs to", + "additionalProperties" : { + "type" : "string" + } + }, + "fieldDescriptors" : { + "type" : "array", + "description" : "The Descriptors that provide information on each of the metrics provided in the status history", + "items" : { + "$ref" : "#/definitions/StatusDescriptorDTO" + } + }, + "aggregateSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeStatusSnapshotsDTO" + } + } + } + }, + "StatusHistoryEntity" : { + "type" : "object", + "properties" : { + "statusHistory" : { + "$ref" : "#/definitions/StatusHistoryDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "statusHistoryEntity" + } + }, + "StatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of the snapshot." + }, + "statusMetrics" : { + "type" : "object", + "description" : "The status metrics.", + "additionalProperties" : { + "type" : "integer", + "format" : "int64" + } + } + } + }, + "StorageUsageDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." + }, + "freeSpace" : { + "type" : "string", + "description" : "Amount of free space." + }, + "totalSpace" : { + "type" : "string", + "description" : "Amount of total space." + }, + "usedSpace" : { + "type" : "string", + "description" : "Amount of used space." + }, + "freeSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of free space." + }, + "totalSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of total space." + }, + "usedSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of used space." + }, + "utilization" : { + "type" : "string", + "description" : "Utilization of this storage location." + } + } + }, + "StreamingOutput" : { + "type" : "object" + }, + "SubmitReplayRequestEntity" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event identifier" + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier of the node where to submit the replay request." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "SystemDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" + } + } + } + }, + "SystemDiagnosticsEntity" : { + "type" : "object", + "properties" : { + "systemDiagnostics" : { + "$ref" : "#/definitions/SystemDiagnosticsDTO" + } + }, + "xml" : { + "name" : "systemDiagnosticsEntity" + } + }, + "SystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "totalNonHeap" : { + "type" : "string", + "description" : "Total size of non heap." + }, + "totalNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes allocated to the JVM not used for heap" + }, + "usedNonHeap" : { + "type" : "string", + "description" : "Amount of use non heap." + }, + "usedNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes used by the JVM not in the heap space" + }, + "freeNonHeap" : { + "type" : "string", + "description" : "Amount of free non heap." + }, + "freeNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of free non-heap bytes available to the JVM" + }, + "maxNonHeap" : { + "type" : "string", + "description" : "Maximum size of non heap." + }, + "maxNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" + }, + "nonHeapUtilization" : { + "type" : "string", + "description" : "Utilization of non heap." + }, + "totalHeap" : { + "type" : "string", + "description" : "Total size of heap." + }, + "totalHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of bytes that are available for the JVM heap to use" + }, + "usedHeap" : { + "type" : "string", + "description" : "Amount of used heap." + }, + "usedHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of JVM heap that are currently being used" + }, + "freeHeap" : { + "type" : "string", + "description" : "Amount of free heap." + }, + "freeHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" + }, + "maxHeap" : { + "type" : "string", + "description" : "Maximum size of heap." + }, + "maxHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that can be used by the JVM" + }, + "heapUtilization" : { + "type" : "string", + "description" : "Utilization of heap." + }, + "availableProcessors" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of available processors if supported by the underlying system." + }, + "processorLoadAverage" : { + "type" : "number", + "format" : "double", + "description" : "The processor load average if supported by the underlying system." + }, + "totalThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of threads." + }, + "daemonThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of daemon threads." + }, + "uptime" : { + "type" : "string", + "description" : "The uptime of the Java virtual machine" + }, + "flowFileRepositoryStorageUsage" : { + "description" : "The flowfile repository storage usage.", + "$ref" : "#/definitions/StorageUsageDTO" + }, + "contentRepositoryStorageUsage" : { + "type" : "array", + "description" : "The content repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "provenanceRepositoryStorageUsage" : { + "type" : "array", + "description" : "The provenance repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "garbageCollection" : { + "type" : "array", + "description" : "The garbage collection details.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/GarbageCollectionDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "When the diagnostics were generated." + }, + "versionInfo" : { + "description" : "The nifi, os, java, and build version information", + "$ref" : "#/definitions/VersionInfoDTO" + } + } + }, + "TemplateDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI for the template." + }, + "id" : { + "type" : "string", + "description" : "The id of the template." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the Process Group that the template belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when this template was created." + }, + "encodingVersion" : { + "type" : "string", + "xml" : { + "name" : "encoding-version", + "attribute" : true + }, + "description" : "The encoding version of this template." + }, + "snippet" : { + "description" : "The contents of the template.", + "$ref" : "#/definitions/FlowSnippetDTO" + } + }, + "xml" : { + "name" : "template" + } + }, + "TemplateEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "template" : { + "$ref" : "#/definitions/TemplateDTO" + } + }, + "xml" : { + "name" : "templateEntity" + } + }, + "TemplatesEntity" : { + "type" : "object", + "properties" : { + "templates" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + } + }, + "xml" : { + "name" : "templatesEntity" + } + }, + "TenantDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + } + } + }, + "TenantEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/TenantDTO" + } + }, + "xml" : { + "name" : "tenantEntity" + } + }, + "TenantsEntity" : { + "type" : "object", + "properties" : { + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + }, + "xml" : { + "name" : "tenantsEntity" + } + }, + "TransactionResultEntity" : { + "type" : "object", + "properties" : { + "flowFileSent" : { + "type" : "integer", + "format" : "int32" + }, + "responseCode" : { + "type" : "integer", + "format" : "int32" + }, + "message" : { + "type" : "string" + } + }, + "xml" : { + "name" : "transactionResultEntity" + } + }, + "UpdateControllerServiceReferenceRequestEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The identifier of the Controller Service." + }, + "state" : { + "type" : "string", + "description" : "The new state of the references for the controller service.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] + }, + "referencingComponentRevisions" : { + "type" : "object", + "description" : "The revisions for all referencing components.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "updateControllerServiceReferenceRequestEntity" + } + }, + "UserDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies this user belongs to.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummaryEntity" + } + } + } + }, + "UserEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserDTO" + } + }, + "xml" : { + "name" : "userEntity" + } + }, + "UserGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "users" : { + "type" : "array", + "description" : "The users that belong to the user group.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "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.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } + } + }, + "UserGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserGroupDTO" + } + }, + "xml" : { + "name" : "userGroupEntity" + } + }, + "UserGroupsEntity" : { + "type" : "object", + "properties" : { + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } + }, + "xml" : { + "name" : "userGroupsEntity" + } + }, + "UsersEntity" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserEntity" + } + } + }, + "xml" : { + "name" : "usersEntity" + } + }, + "VariableDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the variable" + }, + "value" : { + "type" : "string", + "description" : "The value of the variable" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group where this Variable is defined", + "readOnly" : true + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableEntity" : { + "type" : "object", + "properties" : { + "variable" : { + "description" : "The variable information", + "$ref" : "#/definitions/VariableDTO" + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "variableEntity" + } + }, + "VariableRegistryDTO" : { + "type" : "object", + "properties" : { + "variables" : { + "type" : "array", + "description" : "The variables that are available in this Variable Registry", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VariableEntity" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this Variable Registry belongs to" + } + } + }, + "VariableRegistryEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision of the Process Group that the Variable Registry belongs to", + "$ref" : "#/definitions/RevisionDTO" + }, + "variableRegistry" : { + "description" : "The Variable Registry.", + "$ref" : "#/definitions/VariableRegistryDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "variableRegistryEntity" + } + }, + "VariableRegistryUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableRegistryUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Variable Registry Update Request", + "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "variableRegistryUpdateRequestEntity" + } + }, + "VariableRegistryUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "VersionControlComponentMappingEntity" : { + "type" : "object", + "properties" : { + "versionControlComponentMapping" : { + "type" : "object", + "description" : "The mapping of Versioned Component Identifiers to instance ID's", + "additionalProperties" : { + "type" : "string" + } + }, + "processGroupRevision" : { + "description" : "The revision of the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlComponentMappingEntity" + } + }, + "VersionControlInformationDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that is under version control" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is stored in" + }, + "registryName" : { + "type" : "string", + "description" : "The name of the registry that the flow is stored in", + "readOnly" : true + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket that the flow is stored in" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket that the flow is stored in", + "readOnly" : true + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "flowDescription" : { + "type" : "string", + "description" : "The description of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "state" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "stateExplanation" : { + "type" : "string", + "description" : "Explanation of why the group is in the specified state", + "readOnly" : true + } + } + }, + "VersionControlInformationEntity" : { + "type" : "object", + "properties" : { + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "processGroupRevision" : { + "description" : "The Revision for the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionControlInformationEntity" + } + }, + "VersionInfoDTO" : { + "type" : "object", + "properties" : { + "niFiVersion" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "javaVendor" : { + "type" : "string", + "description" : "Java JVM vendor" + }, + "javaVersion" : { + "type" : "string", + "description" : "Java version" + }, + "osName" : { + "type" : "string", + "description" : "Host operating system name" + }, + "osVersion" : { + "type" : "string", + "description" : "Host operating system version" + }, + "osArchitecture" : { + "type" : "string", + "description" : "Host operating system architecture" + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Build timestamp" + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "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." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/Bundle" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "readOnly" : true, + "minimum" : 0 + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDTO" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is tracked to" + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket where the flow is stored" + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "description" : { + "type" : "string", + "description" : "A description of the flow" + }, + "comments" : { + "type" : "string", + "description" : "Comments for the changeset" + }, + "action" : { + "type" : "string", + "description" : "The action being performed", + "enum" : [ "COMMIT", "FORCE_COMMIT" ] + } + } + }, + "VersionedFlowEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + } + }, + "xml" : { + "name" : "versionedFlowEntity" + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "required" : [ "flowContents", "snapshotMetadata" ], + "properties" : { + "snapshotMetadata" : { + "description" : "The metadata for this snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "flowContents" : { + "description" : "The contents of the versioned flow", + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterContexts" : { + "type" : "object", + "description" : "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.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "flow" : { + "description" : "The flow this snapshot is for", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlow" + }, + "bucket" : { + "description" : "The bucket where the flow is located", + "readOnly" : true, + "$ref" : "#/definitions/Bucket" + }, + "latest" : { + "type" : "boolean" + } + } + }, + "VersionedFlowSnapshotEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshot" : { + "description" : "The versioned flow snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + }, + "updateDescendantVersionedFlows" : { + "type" : "boolean", + "description" : "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." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionedFlowSnapshotEntity" + } + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to." + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "readOnly" : true + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + } + } + }, + "VersionedFlowSnapshotMetadataEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadata" : { + "description" : "The collection of versioned flow snapshot metadata", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataEntity" + } + }, + "VersionedFlowSnapshotMetadataSetEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadataSet" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataSetEntity" + } + }, + "VersionedFlowUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this request has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this request failed, or null if this request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + }, + "versionControlInformation" : { + "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", + "readOnly" : true, + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "VersionedFlowUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Versioned Flow Update Request", + "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "versionedFlowUpdateRequestEntity" + } + }, + "VersionedFlowsEntity" : { + "type" : "object", + "properties" : { + "versionedFlows" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowsEntity" + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the context" + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "The type of Processor" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + } + } +} \ No newline at end of file diff --git a/resources/client_gen/generate_api_client.sh b/resources/client_gen/generate_api_client.sh index 50657875..7e5f2996 100755 --- a/resources/client_gen/generate_api_client.sh +++ b/resources/client_gen/generate_api_client.sh @@ -8,7 +8,7 @@ # Params echo Exporting Params -export wv_client_name=${wv_client_name:-registry} +export wv_client_name=${wv_client_name:-nifi} export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-2.3.1.jar} export wv_tmp_dir=${wv_tmp_dir:-${HOME}/Projects/tmp} diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index fa6b435d..f7a94c11 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,7 +2,7 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.9.2 + image: apache/nifi:1.10.0 container_name: nifi hostname: nifi ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index f84b8854..c782fef2 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.1' services: secure-nifi: - image: apache/nifi:1.9.2 + image: apache/nifi:1.10.0 container_name: secure-nifi hostname: secure-nifi ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index b96dac63..b5ca0898 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -19,7 +19,7 @@ services: ports: - "10180:8080" nifi: - image: apache/nifi:1.9.2 + image: apache/nifi:1.10.0 container_name: nifi hostname: nifi ports: From 4c184d69002a8ee3ac528fda63b2ffcc6cedbae5 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 6 Nov 2019 13:40:19 +0000 Subject: [PATCH 17/40] =?UTF-8?q?Bump=20version:=200.13.3=20=E2=86=92=200.?= =?UTF-8?q?14.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- nipyapi/__init__.py | 2 +- setup.cfg | 2 +- setup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index 242bdca0..2ba4a796 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.13.3' +__version__ = '0.14.0' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security'] diff --git a/setup.cfg b/setup.cfg index 7b727c2e..1c245567 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.13.3 +current_version = 0.14.0 commit = True tag = True diff --git a/setup.py b/setup.py index 4e4137c5..06eeee5a 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ with open('docs/history.rst') as history_file: history = history_file.read() -proj_version = '0.13.3' +proj_version = '0.14.0' with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() From 12b77fe71902fe87e0d5f1ff9a2c17ca746c4a99 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 6 Nov 2019 13:49:16 +0000 Subject: [PATCH 18/40] Updated for 0.14.0 release --- docs/history.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/history.rst b/docs/history.rst index a68a6c92..8ef2690f 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,12 @@ History ======= +0.14.0 (2019-11-06) +------------------- + +| Updated NiFi client and helpers to 1.10.0 + + 0.13.3 (2019-10-09) ------------------- From 00adb6a7d8aca5c3590316ddf5a161f94fd97929 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Wed, 6 Nov 2019 14:04:34 +0000 Subject: [PATCH 19/40] Update NiFi Client and helpers to 1.10.0 and add Remote Process Group Controls (#161) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fixes #155 * Added functionality to create/delete/enable/disable remote process groups * Updated NiFi client to support 1.10.0 Updated versioning.save_flow_to_registry for 1.10 compatibility Updated Docker Compose helpers to latest version Updated Readme * Bump version: 0.13.3 → 0.14.0 * Updated for 0.14.0 release --- README.rst | 2 +- docs/history.rst | 6 + nipyapi/__init__.py | 2 +- nipyapi/canvas.py | 86 +- nipyapi/nifi/__init__.py | 31 +- nipyapi/nifi/api_client.py | 2 +- nipyapi/nifi/apis/__init__.py | 1 + nipyapi/nifi/apis/access_api.py | 100 +- nipyapi/nifi/apis/connections_api.py | 2 +- nipyapi/nifi/apis/controller_api.py | 2 +- nipyapi/nifi/apis/controller_services_api.py | 2 +- nipyapi/nifi/apis/counters_api.py | 2 +- nipyapi/nifi/apis/data_transfer_api.py | 2 +- nipyapi/nifi/apis/flow_api.py | 214 +- nipyapi/nifi/apis/flowfile_queues_api.py | 2 +- nipyapi/nifi/apis/funnel_api.py | 2 +- nipyapi/nifi/apis/input_ports_api.py | 2 +- nipyapi/nifi/apis/labels_api.py | 2 +- nipyapi/nifi/apis/output_ports_api.py | 2 +- nipyapi/nifi/apis/parameter_contexts_api.py | 1170 + nipyapi/nifi/apis/policies_api.py | 2 +- nipyapi/nifi/apis/process_groups_api.py | 2 +- nipyapi/nifi/apis/processors_api.py | 2 +- nipyapi/nifi/apis/provenance_api.py | 2 +- nipyapi/nifi/apis/provenance_events_api.py | 2 +- .../nifi/apis/remote_process_groups_api.py | 108 +- nipyapi/nifi/apis/reporting_tasks_api.py | 2 +- nipyapi/nifi/apis/resources_api.py | 2 +- nipyapi/nifi/apis/site_to_site_api.py | 2 +- nipyapi/nifi/apis/snippets_api.py | 2 +- nipyapi/nifi/apis/system_diagnostics_api.py | 2 +- nipyapi/nifi/apis/templates_api.py | 2 +- nipyapi/nifi/apis/tenants_api.py | 2 +- nipyapi/nifi/apis/versions_api.py | 2 +- nipyapi/nifi/configuration.py | 4 +- nipyapi/nifi/models/__init__.py | 30 +- nipyapi/nifi/models/about_dto.py | 2 +- nipyapi/nifi/models/about_entity.py | 2 +- .../nifi/models/access_configuration_dto.py | 2 +- .../models/access_configuration_entity.py | 2 +- nipyapi/nifi/models/access_policy_dto.py | 2 +- nipyapi/nifi/models/access_policy_entity.py | 2 +- .../nifi/models/access_policy_summary_dto.py | 2 +- .../models/access_policy_summary_entity.py | 2 +- nipyapi/nifi/models/access_status_dto.py | 2 +- nipyapi/nifi/models/access_status_entity.py | 2 +- nipyapi/nifi/models/action_details_dto.py | 2 +- nipyapi/nifi/models/action_dto.py | 2 +- nipyapi/nifi/models/action_entity.py | 2 +- .../activate_controller_services_entity.py | 2 +- nipyapi/nifi/models/affected_component_dto.py | 2 +- .../nifi/models/affected_component_entity.py | 70 +- nipyapi/nifi/models/allowable_value_dto.py | 2 +- nipyapi/nifi/models/allowable_value_entity.py | 2 +- nipyapi/nifi/models/attribute_dto.py | 2 +- nipyapi/nifi/models/banner_dto.py | 2 +- nipyapi/nifi/models/banner_entity.py | 2 +- nipyapi/nifi/models/batch_settings_dto.py | 2 +- nipyapi/nifi/models/batch_size.py | 2 +- nipyapi/nifi/models/bucket.py | 66 +- nipyapi/nifi/models/bucket_dto.py | 2 +- nipyapi/nifi/models/bucket_entity.py | 2 +- nipyapi/nifi/models/buckets_entity.py | 2 +- nipyapi/nifi/models/bulletin_board_dto.py | 2 +- nipyapi/nifi/models/bulletin_board_entity.py | 2 +- nipyapi/nifi/models/bulletin_dto.py | 2 +- nipyapi/nifi/models/bulletin_entity.py | 2 +- nipyapi/nifi/models/bundle.py | 2 +- nipyapi/nifi/models/bundle_dto.py | 2 +- nipyapi/nifi/models/cluste_summary_entity.py | 2 +- nipyapi/nifi/models/cluster_dto.py | 2 +- nipyapi/nifi/models/cluster_entity.py | 2 +- .../models/cluster_search_results_entity.py | 2 +- nipyapi/nifi/models/cluster_summary_dto.py | 2 +- nipyapi/nifi/models/component_details_dto.py | 2 +- .../nifi/models/component_difference_dto.py | 2 +- nipyapi/nifi/models/component_history_dto.py | 2 +- .../nifi/models/component_history_entity.py | 2 +- .../nifi/models/component_reference_dto.py | 2 +- .../nifi/models/component_reference_entity.py | 2 +- .../component_restriction_permission_dto.py | 2 +- .../models/component_search_result_dto.py | 2 +- nipyapi/nifi/models/component_state_dto.py | 2 +- nipyapi/nifi/models/component_state_entity.py | 2 +- .../models/component_validation_result_dto.py | 383 + .../component_validation_result_entity.py | 319 + .../component_validation_results_entity.py | 125 + nipyapi/nifi/models/connectable_component.py | 2 +- nipyapi/nifi/models/connectable_dto.py | 2 +- nipyapi/nifi/models/connection_dto.py | 2 +- nipyapi/nifi/models/connection_entity.py | 2 +- .../nifi/models/connection_statistics_dto.py | 209 + .../models/connection_statistics_entity.py | 151 + .../connection_statistics_snapshot_dto.py | 321 + nipyapi/nifi/models/connection_status_dto.py | 2 +- .../nifi/models/connection_status_entity.py | 2 +- ...nection_status_predictions_snapshot_dto.py | 293 + .../models/connection_status_snapshot_dto.py | 32 +- .../connection_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/connections_entity.py | 2 +- .../models/controller_bulletins_entity.py | 2 +- .../models/controller_configuration_dto.py | 2 +- .../models/controller_configuration_entity.py | 2 +- nipyapi/nifi/models/controller_dto.py | 2 +- nipyapi/nifi/models/controller_entity.py | 2 +- nipyapi/nifi/models/controller_service_api.py | 2 +- .../nifi/models/controller_service_api_dto.py | 2 +- nipyapi/nifi/models/controller_service_dto.py | 2 +- .../nifi/models/controller_service_entity.py | 2 +- ...oller_service_referencing_component_dto.py | 3 +- ...er_service_referencing_component_entity.py | 2 +- ...r_service_referencing_components_entity.py | 2 +- .../controller_service_run_status_entity.py | 2 +- .../models/controller_service_status_dto.py | 2 +- .../models/controller_service_types_entity.py | 2 +- .../nifi/models/controller_services_entity.py | 2 +- nipyapi/nifi/models/controller_status_dto.py | 2 +- .../nifi/models/controller_status_entity.py | 2 +- .../models/copy_snippet_request_entity.py | 2 +- nipyapi/nifi/models/counter_dto.py | 2 +- nipyapi/nifi/models/counter_entity.py | 2 +- nipyapi/nifi/models/counters_dto.py | 2 +- nipyapi/nifi/models/counters_entity.py | 2 +- nipyapi/nifi/models/counters_snapshot_dto.py | 2 +- .../models/create_active_request_entity.py | 2 +- .../models/create_template_request_entity.py | 2 +- nipyapi/nifi/models/current_user_entity.py | 32 +- nipyapi/nifi/models/difference_dto.py | 2 +- nipyapi/nifi/models/dimensions_dto.py | 2 +- nipyapi/nifi/models/documented_type_dto.py | 2 +- nipyapi/nifi/models/drop_request_dto.py | 2 +- nipyapi/nifi/models/drop_request_entity.py | 2 +- .../nifi/models/explicit_restriction_dto.py | 2 +- .../external_controller_service_reference.py | 153 + nipyapi/nifi/models/flow_breadcrumb_dto.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_entity.py | 2 +- nipyapi/nifi/models/flow_comparison_entity.py | 2 +- nipyapi/nifi/models/flow_configuration_dto.py | 2 +- .../nifi/models/flow_configuration_entity.py | 2 +- nipyapi/nifi/models/flow_dto.py | 2 +- nipyapi/nifi/models/flow_entity.py | 2 +- nipyapi/nifi/models/flow_file_dto.py | 2 +- nipyapi/nifi/models/flow_file_entity.py | 2 +- nipyapi/nifi/models/flow_file_summary_dto.py | 2 +- nipyapi/nifi/models/flow_snippet_dto.py | 2 +- nipyapi/nifi/models/funnel_dto.py | 2 +- nipyapi/nifi/models/funnel_entity.py | 2 +- nipyapi/nifi/models/funnels_entity.py | 2 +- nipyapi/nifi/models/garbage_collection_dto.py | 2 +- nipyapi/nifi/models/history_dto.py | 2 +- nipyapi/nifi/models/history_entity.py | 2 +- nipyapi/nifi/models/input_ports_entity.py | 2 +- .../instantiate_template_request_entity.py | 2 +- .../models/{uri_builder.py => jaxb_link.py} | 68 +- nipyapi/nifi/models/label_dto.py | 2 +- nipyapi/nifi/models/label_entity.py | 2 +- nipyapi/nifi/models/labels_entity.py | 2 +- nipyapi/nifi/models/lineage_dto.py | 2 +- nipyapi/nifi/models/lineage_entity.py | 2 +- nipyapi/nifi/models/lineage_request_dto.py | 2 +- nipyapi/nifi/models/lineage_results_dto.py | 2 +- nipyapi/nifi/models/link.py | 279 - nipyapi/nifi/models/listing_request_dto.py | 2 +- nipyapi/nifi/models/listing_request_entity.py | 2 +- ...node_connection_statistics_snapshot_dto.py | 209 + .../node_connection_status_snapshot_dto.py | 2 +- .../nifi/models/node_counters_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_dto.py | 2 +- nipyapi/nifi/models/node_entity.py | 2 +- nipyapi/nifi/models/node_event_dto.py | 2 +- .../models/node_port_status_snapshot_dto.py | 2 +- .../node_process_group_status_snapshot_dto.py | 2 +- .../node_processor_status_snapshot_dto.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_search_result_dto.py | 2 +- .../nifi/models/node_status_snapshots_dto.py | 2 +- .../node_system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/output_ports_entity.py | 2 +- nipyapi/nifi/models/parameter_context_dto.py | 237 + .../nifi/models/parameter_context_entity.py | 321 + .../models/parameter_context_reference_dto.py | 153 + .../parameter_context_reference_entity.py | 179 + .../parameter_context_update_request_dto.py | 405 + ...parameter_context_update_request_entity.py | 153 + .../parameter_context_update_step_dto.py | 181 + ...arameter_context_validation_request_dto.py | 405 + ...meter_context_validation_request_entity.py | 153 + .../parameter_context_validation_step_dto.py | 181 + .../nifi/models/parameter_contexts_entity.py | 153 + nipyapi/nifi/models/parameter_dto.py | 237 + nipyapi/nifi/models/parameter_entity.py | 153 + nipyapi/nifi/models/peer_dto.py | 2 +- nipyapi/nifi/models/peers_entity.py | 2 +- nipyapi/nifi/models/permissions.py | 2 +- nipyapi/nifi/models/permissions_dto.py | 2 +- nipyapi/nifi/models/port_dto.py | 36 +- nipyapi/nifi/models/port_entity.py | 36 +- nipyapi/nifi/models/port_run_status_entity.py | 2 +- nipyapi/nifi/models/port_status_dto.py | 2 +- nipyapi/nifi/models/port_status_entity.py | 2 +- .../nifi/models/port_status_snapshot_dto.py | 2 +- .../models/port_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/position.py | 2 +- nipyapi/nifi/models/position_dto.py | 2 +- nipyapi/nifi/models/previous_value_dto.py | 2 +- .../nifi/models/prioritizer_types_entity.py | 2 +- nipyapi/nifi/models/process_group_dto.py | 202 +- nipyapi/nifi/models/process_group_entity.py | 144 +- nipyapi/nifi/models/process_group_flow_dto.py | 32 +- .../nifi/models/process_group_flow_entity.py | 2 +- nipyapi/nifi/models/process_group_name_dto.py | 153 + .../nifi/models/process_group_status_dto.py | 2 +- .../models/process_group_status_entity.py | 2 +- .../process_group_status_snapshot_dto.py | 2 +- .../process_group_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/process_groups_entity.py | 2 +- nipyapi/nifi/models/processor_config_dto.py | 2 +- nipyapi/nifi/models/processor_dto.py | 2 +- nipyapi/nifi/models/processor_entity.py | 2 +- .../models/processor_run_status_entity.py | 2 +- nipyapi/nifi/models/processor_status_dto.py | 2 +- .../nifi/models/processor_status_entity.py | 2 +- .../models/processor_status_snapshot_dto.py | 2 +- .../processor_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/processor_types_entity.py | 2 +- nipyapi/nifi/models/processors_entity.py | 2 +- .../nifi/models/property_descriptor_dto.py | 2 +- .../nifi/models/property_descriptor_entity.py | 2 +- nipyapi/nifi/models/property_history_dto.py | 2 +- nipyapi/nifi/models/provenance_dto.py | 2 +- nipyapi/nifi/models/provenance_entity.py | 2 +- nipyapi/nifi/models/provenance_event_dto.py | 2 +- .../nifi/models/provenance_event_entity.py | 2 +- nipyapi/nifi/models/provenance_link_dto.py | 2 +- nipyapi/nifi/models/provenance_node_dto.py | 2 +- nipyapi/nifi/models/provenance_options_dto.py | 2 +- .../nifi/models/provenance_options_entity.py | 2 +- nipyapi/nifi/models/provenance_request_dto.py | 2 +- nipyapi/nifi/models/provenance_results_dto.py | 2 +- .../models/provenance_searchable_field_dto.py | 2 +- nipyapi/nifi/models/queue_size_dto.py | 2 +- nipyapi/nifi/models/registry_client_entity.py | 2 +- .../nifi/models/registry_clients_entity.py | 2 +- nipyapi/nifi/models/registry_dto.py | 2 +- nipyapi/nifi/models/relationship_dto.py | 2 +- .../models/remote_port_run_status_entity.py | 2 +- .../remote_process_group_contents_dto.py | 2 +- .../nifi/models/remote_process_group_dto.py | 2 +- .../models/remote_process_group_entity.py | 2 +- .../models/remote_process_group_port_dto.py | 2 +- .../remote_process_group_port_entity.py | 2 +- .../models/remote_process_group_status_dto.py | 2 +- .../remote_process_group_status_entity.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- ...te_process_group_status_snapshot_entity.py | 2 +- .../models/remote_process_groups_entity.py | 2 +- nipyapi/nifi/models/reporting_task_dto.py | 2 +- nipyapi/nifi/models/reporting_task_entity.py | 2 +- .../reporting_task_run_status_entity.py | 2 +- .../nifi/models/reporting_task_status_dto.py | 2 +- .../models/reporting_task_types_entity.py | 2 +- nipyapi/nifi/models/reporting_tasks_entity.py | 2 +- .../nifi/models/required_permission_dto.py | 2 +- nipyapi/nifi/models/resource_dto.py | 2 +- nipyapi/nifi/models/resources_entity.py | 2 +- nipyapi/nifi/models/revision_dto.py | 2 +- .../nifi/models/schedule_components_entity.py | 2 +- .../nifi/models/search_result_group_dto.py | 2 +- nipyapi/nifi/models/search_results_dto.py | 64 +- nipyapi/nifi/models/search_results_entity.py | 2 +- nipyapi/nifi/models/snippet_dto.py | 2 +- nipyapi/nifi/models/snippet_entity.py | 2 +- .../start_version_control_request_entity.py | 2 +- nipyapi/nifi/models/state_entry_dto.py | 2 +- nipyapi/nifi/models/state_map_dto.py | 2 +- nipyapi/nifi/models/status_descriptor_dto.py | 2 +- nipyapi/nifi/models/status_history_dto.py | 2 +- nipyapi/nifi/models/status_history_entity.py | 2 +- nipyapi/nifi/models/status_snapshot_dto.py | 2 +- nipyapi/nifi/models/storage_usage_dto.py | 2 +- nipyapi/nifi/models/streaming_output.py | 2 +- .../models/submit_replay_request_entity.py | 2 +- nipyapi/nifi/models/system_diagnostics_dto.py | 2 +- .../nifi/models/system_diagnostics_entity.py | 2 +- .../models/system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/template_dto.py | 2 +- nipyapi/nifi/models/template_entity.py | 2 +- nipyapi/nifi/models/templates_entity.py | 2 +- nipyapi/nifi/models/tenant_dto.py | 2 +- nipyapi/nifi/models/tenant_entity.py | 2 +- nipyapi/nifi/models/tenants_entity.py | 2 +- .../nifi/models/transaction_result_entity.py | 2 +- ...roller_service_reference_request_entity.py | 2 +- nipyapi/nifi/models/user_dto.py | 2 +- nipyapi/nifi/models/user_entity.py | 2 +- nipyapi/nifi/models/user_group_dto.py | 2 +- nipyapi/nifi/models/user_group_entity.py | 2 +- nipyapi/nifi/models/user_groups_entity.py | 2 +- nipyapi/nifi/models/users_entity.py | 2 +- nipyapi/nifi/models/variable_dto.py | 2 +- nipyapi/nifi/models/variable_entity.py | 2 +- nipyapi/nifi/models/variable_registry_dto.py | 2 +- .../nifi/models/variable_registry_entity.py | 2 +- .../variable_registry_update_request_dto.py | 152 +- ...variable_registry_update_request_entity.py | 2 +- .../variable_registry_update_step_dto.py | 2 +- ...ersion_control_component_mapping_entity.py | 2 +- .../models/version_control_information_dto.py | 2 +- .../version_control_information_entity.py | 2 +- nipyapi/nifi/models/version_info_dto.py | 2 +- nipyapi/nifi/models/versioned_connection.py | 2 +- .../models/versioned_controller_service.py | 2 +- nipyapi/nifi/models/versioned_flow.py | 10 +- .../nifi/models/versioned_flow_coordinates.py | 2 +- nipyapi/nifi/models/versioned_flow_dto.py | 42 +- nipyapi/nifi/models/versioned_flow_entity.py | 2 +- .../nifi/models/versioned_flow_snapshot.py | 88 +- .../models/versioned_flow_snapshot_entity.py | 2 +- .../versioned_flow_snapshot_metadata.py | 12 +- ...versioned_flow_snapshot_metadata_entity.py | 2 +- ...ioned_flow_snapshot_metadata_set_entity.py | 2 +- .../versioned_flow_update_request_dto.py | 2 +- .../versioned_flow_update_request_entity.py | 2 +- nipyapi/nifi/models/versioned_flows_entity.py | 2 +- nipyapi/nifi/models/versioned_funnel.py | 2 +- nipyapi/nifi/models/versioned_label.py | 2 +- nipyapi/nifi/models/versioned_parameter.py | 209 + .../models/versioned_parameter_context.py | 181 + nipyapi/nifi/models/versioned_port.py | 66 +- .../nifi/models/versioned_process_group.py | 32 +- nipyapi/nifi/models/versioned_processor.py | 38 +- .../models/versioned_property_descriptor.py | 2 +- .../models/versioned_remote_group_port.py | 38 +- .../models/versioned_remote_process_group.py | 2 +- nipyapi/nifi/rest.py | 2 +- nipyapi/versioning.py | 3 +- .../api_defs/nifi-1.10.0-swagger.json | 20603 ++++++++++++++++ resources/client_gen/generate_api_client.sh | 2 +- resources/docker/latest/docker-compose.yml | 2 +- resources/docker/secure/docker-compose.yml | 2 +- resources/docker/tox-full/docker-compose.yml | 2 +- setup.cfg | 2 +- setup.py | 2 +- tests/conftest.py | 8 + tests/test_canvas.py | 15 + 345 files changed, 29388 insertions(+), 718 deletions(-) create mode 100644 nipyapi/nifi/apis/parameter_contexts_api.py create mode 100644 nipyapi/nifi/models/component_validation_result_dto.py create mode 100644 nipyapi/nifi/models/component_validation_result_entity.py create mode 100644 nipyapi/nifi/models/component_validation_results_entity.py create mode 100644 nipyapi/nifi/models/connection_statistics_dto.py create mode 100644 nipyapi/nifi/models/connection_statistics_entity.py create mode 100644 nipyapi/nifi/models/connection_statistics_snapshot_dto.py create mode 100644 nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py create mode 100644 nipyapi/nifi/models/external_controller_service_reference.py rename nipyapi/nifi/models/{uri_builder.py => jaxb_link.py} (64%) delete mode 100644 nipyapi/nifi/models/link.py create mode 100644 nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_reference_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_reference_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_update_request_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_update_request_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_update_step_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_validation_request_dto.py create mode 100644 nipyapi/nifi/models/parameter_context_validation_request_entity.py create mode 100644 nipyapi/nifi/models/parameter_context_validation_step_dto.py create mode 100644 nipyapi/nifi/models/parameter_contexts_entity.py create mode 100644 nipyapi/nifi/models/parameter_dto.py create mode 100644 nipyapi/nifi/models/parameter_entity.py create mode 100644 nipyapi/nifi/models/process_group_name_dto.py create mode 100644 nipyapi/nifi/models/versioned_parameter.py create mode 100644 nipyapi/nifi/models/versioned_parameter_context.py create mode 100644 resources/client_gen/api_defs/nifi-1.10.0-swagger.json diff --git a/README.rst b/README.rst index c120ca0b..49d8f458 100644 --- a/README.rst +++ b/README.rst @@ -97,7 +97,7 @@ Background and Documentation NiFi Version Support -------------------- -| Currently we are testing against NiFi versions 1.1.2 - 1.9.2, and NiFi-Registry versions 0.1.0 - 0.3.0. +| Currently we are testing against NiFi versions 1.1.2 - 1.10, and NiFi-Registry versions 0.1.0 - 0.5.0. | If you find a version compatibility problem please raise an `issue `_ Python Requirements diff --git a/docs/history.rst b/docs/history.rst index a68a6c92..8ef2690f 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,12 @@ History ======= +0.14.0 (2019-11-06) +------------------- + +| Updated NiFi client and helpers to 1.10.0 + + 0.13.3 (2019-10-09) ------------------- diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index 242bdca0..2ba4a796 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.13.3' +__version__ = '0.14.0' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security'] diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index a163f0eb..7a2779de 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -24,7 +24,9 @@ 'schedule_controller', 'get_controller', 'list_all_controller_types', 'list_all_by_kind', 'list_all_input_ports', 'list_all_output_ports', 'list_all_funnels', 'list_all_remote_process_groups', 'delete_funnel', - 'get_remote_process_group', 'update_process_group', 'create_funnel' + 'get_remote_process_group', 'update_process_group', 'create_funnel', + 'create_remote_process_group', 'delete_remote_process_group', + 'set_remote_process_group_transmission' ] log = logging.getLogger(__name__) @@ -1336,6 +1338,88 @@ def get_remote_process_group(rpg_id, summary=False): return out +def create_remote_process_group(target_uris, transport='RAW', pg_id='root', position=None): + """ + Creates a new Remote Process Group with given parameters + + Args: + 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) + """ + assert isinstance(target_uris, str) + assert transport in ['RAW', 'HTTP'] + assert isinstance(pg_id, str) + pg_id = pg_id if not 'root' else get_root_pg_id() + position = position if position else (400, 400) + assert isinstance(position, tuple) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.ProcessGroupsApi().create_remote_process_group( + id=pg_id, + body=nipyapi.nifi.RemoteProcessGroupEntity( + component=nipyapi.nifi.RemoteProcessGroupDTO( + position=nipyapi.nifi.PositionDTO( + x=float(position[0]), + y=float(position[1]) + ), + target_uris=target_uris, + transport_protocol=transport + ), + revision=nipyapi.nifi.RevisionDTO(version=0), + ) + ) + + +def delete_remote_process_group(rpg, refresh=True): + """ + Deletes a given remote process group + + Args: + rpg (RemoteProcessGroupEntity): Remote Process Group to remove + refresh (bool): Whether to refresh the object before action + + Returns: + (RemoteProcessGroupEntity) + """ + assert isinstance(rpg, nipyapi.nifi.RemoteProcessGroupEntity) + if refresh: + rpg = get_remote_process_group(rpg.id) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.RemoteProcessGroupsApi().remove_remote_process_group( + id=rpg.id, + version=rpg.revision.version + ) + + +def set_remote_process_group_transmission(rpg, enable=True, refresh=True): + """ + + Args: + 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: + + """ + assert isinstance(rpg, nipyapi.nifi.RemoteProcessGroupEntity) + assert isinstance(enable, bool) + if refresh: + rpg = get_remote_process_group(rpg.id) + with nipyapi.utils.rest_exceptions(): + return nipyapi.nifi.RemoteProcessGroupsApi().update_remote_process_group_run_status( + id=rpg.id, + body=nipyapi.nifi.RemotePortRunStatusEntity( + state='TRANSMITTING' if enable else 'STOPPED', + revision=rpg.revision + ) + ) + + def create_port(pg_id, port_type, name, state, position=None): """ Creates a new input or output port of given characteristics diff --git a/nipyapi/nifi/__init__.py b/nipyapi/nifi/__init__.py index ce0b4d70..b8991446 100644 --- a/nipyapi/nifi/__init__.py +++ b/nipyapi/nifi/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,12 +62,19 @@ from .models.component_search_result_dto import ComponentSearchResultDTO from .models.component_state_dto import ComponentStateDTO from .models.component_state_entity import ComponentStateEntity +from .models.component_validation_result_dto import ComponentValidationResultDTO +from .models.component_validation_result_entity import ComponentValidationResultEntity +from .models.component_validation_results_entity import ComponentValidationResultsEntity from .models.connectable_component import ConnectableComponent from .models.connectable_dto import ConnectableDTO from .models.connection_dto import ConnectionDTO from .models.connection_entity import ConnectionEntity +from .models.connection_statistics_dto import ConnectionStatisticsDTO +from .models.connection_statistics_entity import ConnectionStatisticsEntity +from .models.connection_statistics_snapshot_dto import ConnectionStatisticsSnapshotDTO from .models.connection_status_dto import ConnectionStatusDTO from .models.connection_status_entity import ConnectionStatusEntity +from .models.connection_status_predictions_snapshot_dto import ConnectionStatusPredictionsSnapshotDTO from .models.connection_status_snapshot_dto import ConnectionStatusSnapshotDTO from .models.connection_status_snapshot_entity import ConnectionStatusSnapshotEntity from .models.connections_entity import ConnectionsEntity @@ -104,6 +111,7 @@ from .models.drop_request_dto import DropRequestDTO from .models.drop_request_entity import DropRequestEntity from .models.explicit_restriction_dto import ExplicitRestrictionDTO +from .models.external_controller_service_reference import ExternalControllerServiceReference from .models.flow_breadcrumb_dto import FlowBreadcrumbDTO from .models.flow_breadcrumb_entity import FlowBreadcrumbEntity from .models.flow_comparison_entity import FlowComparisonEntity @@ -123,6 +131,7 @@ from .models.history_entity import HistoryEntity from .models.input_ports_entity import InputPortsEntity from .models.instantiate_template_request_entity import InstantiateTemplateRequestEntity +from .models.jaxb_link import JaxbLink from .models.label_dto import LabelDTO from .models.label_entity import LabelEntity from .models.labels_entity import LabelsEntity @@ -130,9 +139,9 @@ from .models.lineage_entity import LineageEntity from .models.lineage_request_dto import LineageRequestDTO from .models.lineage_results_dto import LineageResultsDTO -from .models.link import Link from .models.listing_request_dto import ListingRequestDTO from .models.listing_request_entity import ListingRequestEntity +from .models.node_connection_statistics_snapshot_dto import NodeConnectionStatisticsSnapshotDTO from .models.node_connection_status_snapshot_dto import NodeConnectionStatusSnapshotDTO from .models.node_counters_snapshot_dto import NodeCountersSnapshotDTO from .models.node_dto import NodeDTO @@ -146,6 +155,19 @@ from .models.node_status_snapshots_dto import NodeStatusSnapshotsDTO from .models.node_system_diagnostics_snapshot_dto import NodeSystemDiagnosticsSnapshotDTO from .models.output_ports_entity import OutputPortsEntity +from .models.parameter_context_dto import ParameterContextDTO +from .models.parameter_context_entity import ParameterContextEntity +from .models.parameter_context_reference_dto import ParameterContextReferenceDTO +from .models.parameter_context_reference_entity import ParameterContextReferenceEntity +from .models.parameter_context_update_request_dto import ParameterContextUpdateRequestDTO +from .models.parameter_context_update_request_entity import ParameterContextUpdateRequestEntity +from .models.parameter_context_update_step_dto import ParameterContextUpdateStepDTO +from .models.parameter_context_validation_request_dto import ParameterContextValidationRequestDTO +from .models.parameter_context_validation_request_entity import ParameterContextValidationRequestEntity +from .models.parameter_context_validation_step_dto import ParameterContextValidationStepDTO +from .models.parameter_contexts_entity import ParameterContextsEntity +from .models.parameter_dto import ParameterDTO +from .models.parameter_entity import ParameterEntity from .models.peer_dto import PeerDTO from .models.peers_entity import PeersEntity from .models.permissions import Permissions @@ -165,6 +187,7 @@ from .models.process_group_entity import ProcessGroupEntity from .models.process_group_flow_dto import ProcessGroupFlowDTO from .models.process_group_flow_entity import ProcessGroupFlowEntity +from .models.process_group_name_dto import ProcessGroupNameDTO from .models.process_group_status_dto import ProcessGroupStatusDTO from .models.process_group_status_entity import ProcessGroupStatusEntity from .models.process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO @@ -247,7 +270,6 @@ from .models.tenants_entity import TenantsEntity from .models.transaction_result_entity import TransactionResultEntity from .models.update_controller_service_reference_request_entity import UpdateControllerServiceReferenceRequestEntity -from .models.uri_builder import UriBuilder from .models.user_dto import UserDTO from .models.user_entity import UserEntity from .models.user_group_dto import UserGroupDTO @@ -281,6 +303,8 @@ from .models.versioned_flows_entity import VersionedFlowsEntity from .models.versioned_funnel import VersionedFunnel from .models.versioned_label import VersionedLabel +from .models.versioned_parameter import VersionedParameter +from .models.versioned_parameter_context import VersionedParameterContext from .models.versioned_port import VersionedPort from .models.versioned_process_group import VersionedProcessGroup from .models.versioned_processor import VersionedProcessor @@ -301,6 +325,7 @@ from .apis.input_ports_api import InputPortsApi from .apis.labels_api import LabelsApi from .apis.output_ports_api import OutputPortsApi +from .apis.parameter_contexts_api import ParameterContextsApi from .apis.policies_api import PoliciesApi from .apis.process_groups_api import ProcessGroupsApi from .apis.processors_api import ProcessorsApi diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index 38b497fe..4a15100b 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -4,7 +4,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/__init__.py b/nipyapi/nifi/apis/__init__.py index 384223cf..2e58f9b2 100644 --- a/nipyapi/nifi/apis/__init__.py +++ b/nipyapi/nifi/apis/__init__.py @@ -13,6 +13,7 @@ from .input_ports_api import InputPortsApi from .labels_api import LabelsApi from .output_ports_api import OutputPortsApi +from .parameter_contexts_api import ParameterContextsApi from .policies_api import PoliciesApi from .process_groups_api import ProcessGroupsApi from .processors_api import ProcessorsApi diff --git a/nipyapi/nifi/apis/access_api.py b/nipyapi/nifi/apis/access_api.py index 9279066c..5531aa02 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -931,6 +931,104 @@ def knox_request_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def log_out(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.log_out_with_http_info(**kwargs) + else: + (data) = self.log_out_with_http_info(**kwargs) + return data + + def log_out_with_http_info(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method log_out" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['*/*']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/access/logout', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def oidc_callback(self, **kwargs): """ Redirect/callback URI for processing the result of the OpenId Connect login sequence. diff --git a/nipyapi/nifi/apis/connections_api.py b/nipyapi/nifi/apis/connections_api.py index a1c96cac..fb88c5c8 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index 4efd0bfe..fcc49e0a 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_services_api.py b/nipyapi/nifi/apis/controller_services_api.py index d0a3be68..0c87aa3b 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/counters_api.py b/nipyapi/nifi/apis/counters_api.py index 027da569..b1f30c6a 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/data_transfer_api.py b/nipyapi/nifi/apis/data_transfer_api.py index 3f52ece7..851f29f7 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/flow_api.py b/nipyapi/nifi/apis/flow_api.py index b1d902b8..d7868da5 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -1084,6 +1084,120 @@ def get_component_history_with_http_info(self, component_id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_connection_statistics(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The connection id. (required) + :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false + :param str cluster_node_id: The id of the node where to get the statistics. + :return: ConnectionStatisticsEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_connection_statistics_with_http_info(id, **kwargs) + else: + (data) = self.get_connection_statistics_with_http_info(id, **kwargs) + return data + + def get_connection_statistics_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The connection id. (required) + :param bool nodewise: Whether or not to include the breakdown per node. Optional, defaults to false + :param str cluster_node_id: The id of the node where to get the statistics. + :return: ConnectionStatisticsEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'nodewise', 'cluster_node_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_connection_statistics" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_connection_statistics`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'nodewise' in params: + query_params.append(('nodewise', params['nodewise'])) + if 'cluster_node_id' in params: + query_params.append(('clusterNodeId', params['cluster_node_id'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/flow/connections/{id}/statistics', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ConnectionStatisticsEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_connection_status(self, id, **kwargs): """ Gets status for a connection @@ -2384,6 +2498,104 @@ def get_output_port_status_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_parameter_contexts(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: ParameterContextsEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_parameter_contexts_with_http_info(**kwargs) + else: + (data) = self.get_parameter_contexts_with_http_info(**kwargs) + return data + + def get_parameter_contexts_with_http_info(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: ParameterContextsEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_parameter_contexts" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/flow/parameter-contexts', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextsEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_prioritizers(self, **kwargs): """ Retrieves the types of prioritizers that this NiFi supports diff --git a/nipyapi/nifi/apis/flowfile_queues_api.py b/nipyapi/nifi/apis/flowfile_queues_api.py index 5ce4857b..824cf6ea 100644 --- a/nipyapi/nifi/apis/flowfile_queues_api.py +++ b/nipyapi/nifi/apis/flowfile_queues_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/funnel_api.py b/nipyapi/nifi/apis/funnel_api.py index 4e59788f..24d375c5 100644 --- a/nipyapi/nifi/apis/funnel_api.py +++ b/nipyapi/nifi/apis/funnel_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/input_ports_api.py b/nipyapi/nifi/apis/input_ports_api.py index 1f75b6e2..c174c532 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/labels_api.py b/nipyapi/nifi/apis/labels_api.py index 9a80ebf1..87d40b9e 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/output_ports_api.py b/nipyapi/nifi/apis/output_ports_api.py index d6abf134..cd43a78e 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/parameter_contexts_api.py b/nipyapi/nifi/apis/parameter_contexts_api.py new file mode 100644 index 00000000..c59ff626 --- /dev/null +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -0,0 +1,1170 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient + + +class ParameterContextsApi(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 + """ + + def __init__(self, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + + def create_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param ParameterContextEntity body: The Parameter Context. (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_parameter_context_with_http_info(body, **kwargs) + else: + (data) = self.create_parameter_context_with_http_info(body, **kwargs) + return data + + def create_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param ParameterContextEntity body: The Parameter Context. (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `create_parameter_context`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The Parameter Context ID. (required) + :param str version: The version is used to verify the client is working with the latest version of the flow. + :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_parameter_context_with_http_info(id, **kwargs) + else: + (data) = self.delete_parameter_context_with_http_info(id, **kwargs) + return data + + def delete_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The Parameter Context ID. (required) + :param str version: The version is used to verify the client is working with the latest version of the flow. + :param str client_id: If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'version', 'client_id', 'disconnected_node_acknowledged'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `delete_parameter_context`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'version' in params: + query_params.append(('version', params['version'])) + if 'client_id' in params: + query_params.append(('clientId', params['client_id'])) + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_update_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the ParameterContext (required) + :param str request_id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_update_request_with_http_info(context_id, request_id, **kwargs) + else: + (data) = self.delete_update_request_with_http_info(context_id, request_id, **kwargs) + return data + + def delete_update_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the ParameterContext (required) + :param str request_id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'request_id', 'disconnected_node_acknowledged'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_update_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `delete_update_request`") + # verify the required parameter 'request_id' is set + if ('request_id' not in params) or (params['request_id'] is None): + raise ValueError("Missing the required parameter `request_id` when calling `delete_update_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'request_id' in params: + path_params['requestId'] = params['request_id'] + + query_params = [] + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextUpdateRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_validation_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_validation_request_with_http_info(context_id, id, **kwargs) + else: + (data) = self.delete_validation_request_with_http_info(context_id, id, **kwargs) + return data + + def delete_validation_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'id', 'disconnected_node_acknowledged'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_validation_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `delete_validation_request`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `delete_validation_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextValidationRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_parameter_context_with_http_info(id, **kwargs) + else: + (data) = self.get_parameter_context_with_http_info(id, **kwargs) + return data + + def get_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_parameter_context`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_parameter_context_update(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str request_id: The ID of the Update Request (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_parameter_context_update_with_http_info(context_id, request_id, **kwargs) + else: + (data) = self.get_parameter_context_update_with_http_info(context_id, request_id, **kwargs) + return data + + def get_parameter_context_update_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str request_id: The ID of the Update Request (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'request_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_parameter_context_update" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `get_parameter_context_update`") + # verify the required parameter 'request_id' is set + if ('request_id' not in params) or (params['request_id'] is None): + raise ValueError("Missing the required parameter `request_id` when calling `get_parameter_context_update`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'request_id' in params: + path_params['requestId'] = params['request_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextUpdateRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_validation_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Validation Request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_validation_request_with_http_info(context_id, id, **kwargs) + else: + (data) = self.get_validation_request_with_http_info(context_id, id, **kwargs) + return data + + def get_validation_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: The ID of the Parameter Context (required) + :param str id: The ID of the Validation Request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_validation_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `get_validation_request`") + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_validation_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextValidationRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def submit_parameter_context_update(self, 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 acttion 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextEntity body: The updated version of the parameter context. (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.submit_parameter_context_update_with_http_info(context_id, body, **kwargs) + else: + (data) = self.submit_parameter_context_update_with_http_info(context_id, body, **kwargs) + return data + + def submit_parameter_context_update_with_http_info(self, 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 acttion 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextEntity body: The updated version of the parameter context. (required) + :return: ParameterContextUpdateRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method submit_parameter_context_update" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `submit_parameter_context_update`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `submit_parameter_context_update`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextUpdateRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def submit_validation_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextValidationRequestEntity body: The validation request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.submit_validation_request_with_http_info(context_id, body, **kwargs) + else: + (data) = self.submit_validation_request_with_http_info(context_id, body, **kwargs) + return data + + def submit_validation_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str context_id: (required) + :param ParameterContextValidationRequestEntity body: The validation request (required) + :return: ParameterContextValidationRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['context_id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method submit_validation_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'context_id' is set + if ('context_id' not in params) or (params['context_id'] is None): + raise ValueError("Missing the required parameter `context_id` when calling `submit_validation_request`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `submit_validation_request`") + + + collection_formats = {} + + path_params = {} + if 'context_id' in params: + path_params['contextId'] = params['context_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextValidationRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_parameter_context(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: (required) + :param ParameterContextEntity body: The updated Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.update_parameter_context_with_http_info(id, body, **kwargs) + else: + (data) = self.update_parameter_context_with_http_info(id, body, **kwargs) + return data + + def update_parameter_context_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: (required) + :param ParameterContextEntity body: The updated Parameter Context (required) + :return: ParameterContextEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_parameter_context" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_parameter_context`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `update_parameter_context`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/parameter-contexts/{id}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ParameterContextEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/nipyapi/nifi/apis/policies_api.py b/nipyapi/nifi/apis/policies_api.py index 60843907..46e1c38e 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/process_groups_api.py b/nipyapi/nifi/apis/process_groups_api.py index a3edce41..31f6da0a 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/processors_api.py b/nipyapi/nifi/apis/processors_api.py index abb0b20c..3d447c01 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index 5aac4b96..8f81920b 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_events_api.py b/nipyapi/nifi/apis/provenance_events_api.py index f78f1770..7e1a1dc0 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/remote_process_groups_api.py b/nipyapi/nifi/apis/remote_process_groups_api.py index 1698e979..51efe7d6 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -146,6 +146,112 @@ def get_remote_process_group_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_state(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The processor id. (required) + :return: ComponentStateEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_state_with_http_info(id, **kwargs) + else: + (data) = self.get_state_with_http_info(id, **kwargs) + return data + + def get_state_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The processor id. (required) + :return: ComponentStateEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_state" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_state`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/remote-process-groups/{id}/state', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ComponentStateEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def remove_remote_process_group(self, id, **kwargs): """ Deletes a remote process group diff --git a/nipyapi/nifi/apis/reporting_tasks_api.py b/nipyapi/nifi/apis/reporting_tasks_api.py index 09b064aa..ac5391f7 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/resources_api.py b/nipyapi/nifi/apis/resources_api.py index b504f7cf..e6cb107a 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/site_to_site_api.py b/nipyapi/nifi/apis/site_to_site_api.py index 5022fbb8..003b560d 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/snippets_api.py b/nipyapi/nifi/apis/snippets_api.py index f863245a..f2a71809 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/system_diagnostics_api.py b/nipyapi/nifi/apis/system_diagnostics_api.py index e826a921..fae94739 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/templates_api.py b/nipyapi/nifi/apis/templates_api.py index 6f53a54f..8882986f 100644 --- a/nipyapi/nifi/apis/templates_api.py +++ b/nipyapi/nifi/apis/templates_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/tenants_api.py b/nipyapi/nifi/apis/tenants_api.py index 4f727f24..0eaecf1a 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/versions_api.py b/nipyapi/nifi/apis/versions_api.py index ed455e7e..b9f4bb09 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 3969e5cb..432f5720 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -228,6 +228,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.9.1\n"\ + "Version of the API: 1.10.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/nifi/models/__init__.py b/nipyapi/nifi/models/__init__.py index 43cafc5c..bc65572d 100644 --- a/nipyapi/nifi/models/__init__.py +++ b/nipyapi/nifi/models/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,12 +62,19 @@ from .component_search_result_dto import ComponentSearchResultDTO from .component_state_dto import ComponentStateDTO from .component_state_entity import ComponentStateEntity +from .component_validation_result_dto import ComponentValidationResultDTO +from .component_validation_result_entity import ComponentValidationResultEntity +from .component_validation_results_entity import ComponentValidationResultsEntity from .connectable_component import ConnectableComponent from .connectable_dto import ConnectableDTO from .connection_dto import ConnectionDTO from .connection_entity import ConnectionEntity +from .connection_statistics_dto import ConnectionStatisticsDTO +from .connection_statistics_entity import ConnectionStatisticsEntity +from .connection_statistics_snapshot_dto import ConnectionStatisticsSnapshotDTO from .connection_status_dto import ConnectionStatusDTO from .connection_status_entity import ConnectionStatusEntity +from .connection_status_predictions_snapshot_dto import ConnectionStatusPredictionsSnapshotDTO from .connection_status_snapshot_dto import ConnectionStatusSnapshotDTO from .connection_status_snapshot_entity import ConnectionStatusSnapshotEntity from .connections_entity import ConnectionsEntity @@ -104,6 +111,7 @@ from .drop_request_dto import DropRequestDTO from .drop_request_entity import DropRequestEntity from .explicit_restriction_dto import ExplicitRestrictionDTO +from .external_controller_service_reference import ExternalControllerServiceReference from .flow_breadcrumb_dto import FlowBreadcrumbDTO from .flow_breadcrumb_entity import FlowBreadcrumbEntity from .flow_comparison_entity import FlowComparisonEntity @@ -123,6 +131,7 @@ from .history_entity import HistoryEntity from .input_ports_entity import InputPortsEntity from .instantiate_template_request_entity import InstantiateTemplateRequestEntity +from .jaxb_link import JaxbLink from .label_dto import LabelDTO from .label_entity import LabelEntity from .labels_entity import LabelsEntity @@ -130,9 +139,9 @@ from .lineage_entity import LineageEntity from .lineage_request_dto import LineageRequestDTO from .lineage_results_dto import LineageResultsDTO -from .link import Link from .listing_request_dto import ListingRequestDTO from .listing_request_entity import ListingRequestEntity +from .node_connection_statistics_snapshot_dto import NodeConnectionStatisticsSnapshotDTO from .node_connection_status_snapshot_dto import NodeConnectionStatusSnapshotDTO from .node_counters_snapshot_dto import NodeCountersSnapshotDTO from .node_dto import NodeDTO @@ -146,6 +155,19 @@ from .node_status_snapshots_dto import NodeStatusSnapshotsDTO from .node_system_diagnostics_snapshot_dto import NodeSystemDiagnosticsSnapshotDTO from .output_ports_entity import OutputPortsEntity +from .parameter_context_dto import ParameterContextDTO +from .parameter_context_entity import ParameterContextEntity +from .parameter_context_reference_dto import ParameterContextReferenceDTO +from .parameter_context_reference_entity import ParameterContextReferenceEntity +from .parameter_context_update_request_dto import ParameterContextUpdateRequestDTO +from .parameter_context_update_request_entity import ParameterContextUpdateRequestEntity +from .parameter_context_update_step_dto import ParameterContextUpdateStepDTO +from .parameter_context_validation_request_dto import ParameterContextValidationRequestDTO +from .parameter_context_validation_request_entity import ParameterContextValidationRequestEntity +from .parameter_context_validation_step_dto import ParameterContextValidationStepDTO +from .parameter_contexts_entity import ParameterContextsEntity +from .parameter_dto import ParameterDTO +from .parameter_entity import ParameterEntity from .peer_dto import PeerDTO from .peers_entity import PeersEntity from .permissions import Permissions @@ -165,6 +187,7 @@ from .process_group_entity import ProcessGroupEntity from .process_group_flow_dto import ProcessGroupFlowDTO from .process_group_flow_entity import ProcessGroupFlowEntity +from .process_group_name_dto import ProcessGroupNameDTO from .process_group_status_dto import ProcessGroupStatusDTO from .process_group_status_entity import ProcessGroupStatusEntity from .process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO @@ -247,7 +270,6 @@ from .tenants_entity import TenantsEntity from .transaction_result_entity import TransactionResultEntity from .update_controller_service_reference_request_entity import UpdateControllerServiceReferenceRequestEntity -from .uri_builder import UriBuilder from .user_dto import UserDTO from .user_entity import UserEntity from .user_group_dto import UserGroupDTO @@ -281,6 +303,8 @@ from .versioned_flows_entity import VersionedFlowsEntity from .versioned_funnel import VersionedFunnel from .versioned_label import VersionedLabel +from .versioned_parameter import VersionedParameter +from .versioned_parameter_context import VersionedParameterContext from .versioned_port import VersionedPort from .versioned_process_group import VersionedProcessGroup from .versioned_processor import VersionedProcessor diff --git a/nipyapi/nifi/models/about_dto.py b/nipyapi/nifi/models/about_dto.py index 188ebbc0..7ca899b4 100644 --- a/nipyapi/nifi/models/about_dto.py +++ b/nipyapi/nifi/models/about_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/about_entity.py b/nipyapi/nifi/models/about_entity.py index 7e346eef..3b4171ae 100644 --- a/nipyapi/nifi/models/about_entity.py +++ b/nipyapi/nifi/models/about_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_dto.py b/nipyapi/nifi/models/access_configuration_dto.py index 27e55e56..2eb434da 100644 --- a/nipyapi/nifi/models/access_configuration_dto.py +++ b/nipyapi/nifi/models/access_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_entity.py b/nipyapi/nifi/models/access_configuration_entity.py index db1350ae..408e6a7d 100644 --- a/nipyapi/nifi/models/access_configuration_entity.py +++ b/nipyapi/nifi/models/access_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_dto.py b/nipyapi/nifi/models/access_policy_dto.py index ad0aea3a..5ed63c33 100644 --- a/nipyapi/nifi/models/access_policy_dto.py +++ b/nipyapi/nifi/models/access_policy_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_entity.py b/nipyapi/nifi/models/access_policy_entity.py index db3f1821..fb977d6d 100644 --- a/nipyapi/nifi/models/access_policy_entity.py +++ b/nipyapi/nifi/models/access_policy_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_dto.py b/nipyapi/nifi/models/access_policy_summary_dto.py index cb87b35c..1941664d 100644 --- a/nipyapi/nifi/models/access_policy_summary_dto.py +++ b/nipyapi/nifi/models/access_policy_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_entity.py b/nipyapi/nifi/models/access_policy_summary_entity.py index 593e8043..0570b7d8 100644 --- a/nipyapi/nifi/models/access_policy_summary_entity.py +++ b/nipyapi/nifi/models/access_policy_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_dto.py b/nipyapi/nifi/models/access_status_dto.py index 1733d1d9..155f03c1 100644 --- a/nipyapi/nifi/models/access_status_dto.py +++ b/nipyapi/nifi/models/access_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_entity.py b/nipyapi/nifi/models/access_status_entity.py index 979182ce..bb4297f8 100644 --- a/nipyapi/nifi/models/access_status_entity.py +++ b/nipyapi/nifi/models/access_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_details_dto.py b/nipyapi/nifi/models/action_details_dto.py index 90db49a7..7b91d8a0 100644 --- a/nipyapi/nifi/models/action_details_dto.py +++ b/nipyapi/nifi/models/action_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_dto.py b/nipyapi/nifi/models/action_dto.py index 6a4c52a6..9ac2f541 100644 --- a/nipyapi/nifi/models/action_dto.py +++ b/nipyapi/nifi/models/action_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_entity.py b/nipyapi/nifi/models/action_entity.py index 9c40e849..7c59c5a4 100644 --- a/nipyapi/nifi/models/action_entity.py +++ b/nipyapi/nifi/models/action_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/activate_controller_services_entity.py b/nipyapi/nifi/models/activate_controller_services_entity.py index 61063966..c7787fef 100644 --- a/nipyapi/nifi/models/activate_controller_services_entity.py +++ b/nipyapi/nifi/models/activate_controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_dto.py b/nipyapi/nifi/models/affected_component_dto.py index ca3d6ba8..44f3bdcc 100644 --- a/nipyapi/nifi/models/affected_component_dto.py +++ b/nipyapi/nifi/models/affected_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_entity.py b/nipyapi/nifi/models/affected_component_entity.py index 72dfa38d..42aeb358 100644 --- a/nipyapi/nifi/models/affected_component_entity.py +++ b/nipyapi/nifi/models/affected_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,9 @@ class AffectedComponentEntity(object): 'permissions': 'PermissionsDTO', 'bulletins': 'list[BulletinEntity]', 'disconnected_node_acknowledged': 'bool', - 'component': 'AffectedComponentDTO' + 'component': 'AffectedComponentDTO', + 'process_group': 'ProcessGroupNameDTO', + 'reference_type': 'str' } attribute_map = { @@ -49,10 +51,12 @@ class AffectedComponentEntity(object): 'permissions': 'permissions', 'bulletins': 'bulletins', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', - 'component': 'component' + 'component': 'component', + 'process_group': 'processGroup', + 'reference_type': 'referenceType' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, process_group=None, reference_type=None): """ AffectedComponentEntity - a model defined in Swagger """ @@ -65,6 +69,8 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self._bulletins = None self._disconnected_node_acknowledged = None self._component = None + self._process_group = None + self._reference_type = None if revision is not None: self.revision = revision @@ -82,6 +88,10 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self.disconnected_node_acknowledged = disconnected_node_acknowledged if component is not None: self.component = component + if process_group is not None: + self.process_group = process_group + if reference_type is not None: + self.reference_type = reference_type @property def revision(self): @@ -265,6 +275,58 @@ def component(self, component): self._component = component + @property + def process_group(self): + """ + Gets the process_group of this AffectedComponentEntity. + The Process Group that the component belongs to + + :return: The process_group of this AffectedComponentEntity. + :rtype: ProcessGroupNameDTO + """ + return self._process_group + + @process_group.setter + def process_group(self, process_group): + """ + Sets the process_group of this AffectedComponentEntity. + The Process Group that the component belongs to + + :param process_group: The process_group of this AffectedComponentEntity. + :type: ProcessGroupNameDTO + """ + + self._process_group = process_group + + @property + def reference_type(self): + """ + Gets the reference_type of this AffectedComponentEntity. + The type of component referenced + + :return: The reference_type of this AffectedComponentEntity. + :rtype: str + """ + return self._reference_type + + @reference_type.setter + def reference_type(self, reference_type): + """ + Sets the reference_type of this AffectedComponentEntity. + The type of component referenced + + :param reference_type: The reference_type of this AffectedComponentEntity. + :type: str + """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT"] + if reference_type not in allowed_values: + raise ValueError( + "Invalid value for `reference_type` ({0}), must be one of {1}" + .format(reference_type, allowed_values) + ) + + self._reference_type = reference_type + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/allowable_value_dto.py b/nipyapi/nifi/models/allowable_value_dto.py index 8e61a38d..a79cc4d2 100644 --- a/nipyapi/nifi/models/allowable_value_dto.py +++ b/nipyapi/nifi/models/allowable_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_entity.py b/nipyapi/nifi/models/allowable_value_entity.py index 17f0b700..137c28a6 100644 --- a/nipyapi/nifi/models/allowable_value_entity.py +++ b/nipyapi/nifi/models/allowable_value_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/attribute_dto.py b/nipyapi/nifi/models/attribute_dto.py index 467ad9ce..7153864b 100644 --- a/nipyapi/nifi/models/attribute_dto.py +++ b/nipyapi/nifi/models/attribute_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_dto.py b/nipyapi/nifi/models/banner_dto.py index 491859a5..b90bc3e5 100644 --- a/nipyapi/nifi/models/banner_dto.py +++ b/nipyapi/nifi/models/banner_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_entity.py b/nipyapi/nifi/models/banner_entity.py index 64f91979..b4e829c8 100644 --- a/nipyapi/nifi/models/banner_entity.py +++ b/nipyapi/nifi/models/banner_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_settings_dto.py b/nipyapi/nifi/models/batch_settings_dto.py index b3a13fcf..3ce67048 100644 --- a/nipyapi/nifi/models/batch_settings_dto.py +++ b/nipyapi/nifi/models/batch_settings_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_size.py b/nipyapi/nifi/models/batch_size.py index 1b8b01f2..c65afad6 100644 --- a/nipyapi/nifi/models/batch_size.py +++ b/nipyapi/nifi/models/batch_size.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket.py b/nipyapi/nifi/models/bucket.py index e7eadeb9..f069677d 100644 --- a/nipyapi/nifi/models/bucket.py +++ b/nipyapi/nifi/models/bucket.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,11 +31,13 @@ class Bucket(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'identifier': 'str', 'name': 'str', 'created_timestamp': 'int', 'description': 'str', + 'allow_bundle_redeploy': 'bool', + 'allow_public_read': 'bool', 'permissions': 'Permissions' } @@ -45,10 +47,12 @@ class Bucket(object): 'name': 'name', 'created_timestamp': 'createdTimestamp', 'description': 'description', + 'allow_bundle_redeploy': 'allowBundleRedeploy', + 'allow_public_read': 'allowPublicRead', 'permissions': 'permissions' } - def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, permissions=None): + def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None): """ Bucket - a model defined in Swagger """ @@ -58,6 +62,8 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self._name = None self._created_timestamp = None self._description = None + self._allow_bundle_redeploy = None + self._allow_public_read = None self._permissions = None if link is not None: @@ -69,6 +75,10 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self.created_timestamp = created_timestamp if description is not None: self.description = description + if allow_bundle_redeploy is not None: + self.allow_bundle_redeploy = allow_bundle_redeploy + if allow_public_read is not None: + self.allow_public_read = allow_public_read if permissions is not None: self.permissions = permissions @@ -79,7 +89,7 @@ def link(self): An WebLink to this entity. :return: The link of this Bucket. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -90,7 +100,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this Bucket. - :type: Link + :type: JaxbLink """ self._link = link @@ -191,6 +201,52 @@ def description(self, description): self._description = description + @property + def allow_bundle_redeploy(self): + """ + 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. + + :return: The allow_bundle_redeploy of this Bucket. + :rtype: bool + """ + return self._allow_bundle_redeploy + + @allow_bundle_redeploy.setter + def allow_bundle_redeploy(self, allow_bundle_redeploy): + """ + Sets 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. + + :param allow_bundle_redeploy: The allow_bundle_redeploy of this Bucket. + :type: bool + """ + + self._allow_bundle_redeploy = allow_bundle_redeploy + + @property + def allow_public_read(self): + """ + Gets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users + + :return: The allow_public_read of this Bucket. + :rtype: bool + """ + return self._allow_public_read + + @allow_public_read.setter + def allow_public_read(self, allow_public_read): + """ + Sets the allow_public_read of this Bucket. + Indicates if this bucket allows read access to unauthenticated anonymous users + + :param allow_public_read: The allow_public_read of this Bucket. + :type: bool + """ + + self._allow_public_read = allow_public_read + @property def permissions(self): """ diff --git a/nipyapi/nifi/models/bucket_dto.py b/nipyapi/nifi/models/bucket_dto.py index d22673ce..a5c266ea 100644 --- a/nipyapi/nifi/models/bucket_dto.py +++ b/nipyapi/nifi/models/bucket_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket_entity.py b/nipyapi/nifi/models/bucket_entity.py index e88c3aaf..05a97281 100644 --- a/nipyapi/nifi/models/bucket_entity.py +++ b/nipyapi/nifi/models/bucket_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/buckets_entity.py b/nipyapi/nifi/models/buckets_entity.py index a11bb36b..a85ca054 100644 --- a/nipyapi/nifi/models/buckets_entity.py +++ b/nipyapi/nifi/models/buckets_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_dto.py b/nipyapi/nifi/models/bulletin_board_dto.py index 45c19f43..c82ad8f7 100644 --- a/nipyapi/nifi/models/bulletin_board_dto.py +++ b/nipyapi/nifi/models/bulletin_board_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_entity.py b/nipyapi/nifi/models/bulletin_board_entity.py index 3a9033ad..8b0437b8 100644 --- a/nipyapi/nifi/models/bulletin_board_entity.py +++ b/nipyapi/nifi/models/bulletin_board_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_dto.py b/nipyapi/nifi/models/bulletin_dto.py index 6dc2834e..81ae073a 100644 --- a/nipyapi/nifi/models/bulletin_dto.py +++ b/nipyapi/nifi/models/bulletin_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_entity.py b/nipyapi/nifi/models/bulletin_entity.py index 8027e6e8..c7dfacac 100644 --- a/nipyapi/nifi/models/bulletin_entity.py +++ b/nipyapi/nifi/models/bulletin_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle.py b/nipyapi/nifi/models/bundle.py index 85f5daac..23cdc89d 100644 --- a/nipyapi/nifi/models/bundle.py +++ b/nipyapi/nifi/models/bundle.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle_dto.py b/nipyapi/nifi/models/bundle_dto.py index 50462bb5..dc3d7745 100644 --- a/nipyapi/nifi/models/bundle_dto.py +++ b/nipyapi/nifi/models/bundle_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluste_summary_entity.py b/nipyapi/nifi/models/cluste_summary_entity.py index 3b1453f6..8143865a 100644 --- a/nipyapi/nifi/models/cluste_summary_entity.py +++ b/nipyapi/nifi/models/cluste_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_dto.py b/nipyapi/nifi/models/cluster_dto.py index 381c38de..9f46554c 100644 --- a/nipyapi/nifi/models/cluster_dto.py +++ b/nipyapi/nifi/models/cluster_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_entity.py b/nipyapi/nifi/models/cluster_entity.py index 889438ae..8d28abdd 100644 --- a/nipyapi/nifi/models/cluster_entity.py +++ b/nipyapi/nifi/models/cluster_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_search_results_entity.py b/nipyapi/nifi/models/cluster_search_results_entity.py index abf55d60..55088a1e 100644 --- a/nipyapi/nifi/models/cluster_search_results_entity.py +++ b/nipyapi/nifi/models/cluster_search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_summary_dto.py b/nipyapi/nifi/models/cluster_summary_dto.py index 0a345803..24e30bf1 100644 --- a/nipyapi/nifi/models/cluster_summary_dto.py +++ b/nipyapi/nifi/models/cluster_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_details_dto.py b/nipyapi/nifi/models/component_details_dto.py index 1712f82b..fb4730a7 100644 --- a/nipyapi/nifi/models/component_details_dto.py +++ b/nipyapi/nifi/models/component_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_difference_dto.py b/nipyapi/nifi/models/component_difference_dto.py index 0e962fb1..cb8dad5d 100644 --- a/nipyapi/nifi/models/component_difference_dto.py +++ b/nipyapi/nifi/models/component_difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_dto.py b/nipyapi/nifi/models/component_history_dto.py index 65a968ee..2b7cc956 100644 --- a/nipyapi/nifi/models/component_history_dto.py +++ b/nipyapi/nifi/models/component_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_entity.py b/nipyapi/nifi/models/component_history_entity.py index 68e975bc..75945e31 100644 --- a/nipyapi/nifi/models/component_history_entity.py +++ b/nipyapi/nifi/models/component_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_dto.py b/nipyapi/nifi/models/component_reference_dto.py index 9ee08e27..1015c76c 100644 --- a/nipyapi/nifi/models/component_reference_dto.py +++ b/nipyapi/nifi/models/component_reference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_entity.py b/nipyapi/nifi/models/component_reference_entity.py index 7a9ea8d3..020b7533 100644 --- a/nipyapi/nifi/models/component_reference_entity.py +++ b/nipyapi/nifi/models/component_reference_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_restriction_permission_dto.py b/nipyapi/nifi/models/component_restriction_permission_dto.py index 1cd1c37d..a27a5f87 100644 --- a/nipyapi/nifi/models/component_restriction_permission_dto.py +++ b/nipyapi/nifi/models/component_restriction_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_search_result_dto.py b/nipyapi/nifi/models/component_search_result_dto.py index d0968302..680af7cf 100644 --- a/nipyapi/nifi/models/component_search_result_dto.py +++ b/nipyapi/nifi/models/component_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_dto.py b/nipyapi/nifi/models/component_state_dto.py index 84444f4d..cd52e813 100644 --- a/nipyapi/nifi/models/component_state_dto.py +++ b/nipyapi/nifi/models/component_state_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_entity.py b/nipyapi/nifi/models/component_state_entity.py index f0ee8130..b77c7b09 100644 --- a/nipyapi/nifi/models/component_state_entity.py +++ b/nipyapi/nifi/models/component_state_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_dto.py b/nipyapi/nifi/models/component_validation_result_dto.py new file mode 100644 index 00000000..fff661f5 --- /dev/null +++ b/nipyapi/nifi/models/component_validation_result_dto.py @@ -0,0 +1,383 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ComponentValidationResultDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'process_group_id': 'str', + 'id': 'str', + 'reference_type': 'str', + 'name': 'str', + 'state': 'str', + 'active_thread_count': 'int', + 'validation_errors': 'list[str]', + 'currently_valid': 'bool', + 'results_valid': 'bool', + 'resultant_validation_errors': 'list[str]' + } + + attribute_map = { + 'process_group_id': 'processGroupId', + 'id': 'id', + 'reference_type': 'referenceType', + 'name': 'name', + 'state': 'state', + 'active_thread_count': 'activeThreadCount', + 'validation_errors': 'validationErrors', + 'currently_valid': 'currentlyValid', + 'results_valid': 'resultsValid', + 'resultant_validation_errors': 'resultantValidationErrors' + } + + def __init__(self, process_group_id=None, id=None, reference_type=None, name=None, state=None, active_thread_count=None, validation_errors=None, currently_valid=None, results_valid=None, resultant_validation_errors=None): + """ + ComponentValidationResultDTO - a model defined in Swagger + """ + + self._process_group_id = None + self._id = None + self._reference_type = None + self._name = None + self._state = None + self._active_thread_count = None + self._validation_errors = None + self._currently_valid = None + self._results_valid = None + self._resultant_validation_errors = None + + if process_group_id is not None: + self.process_group_id = process_group_id + if id is not None: + self.id = id + if reference_type is not None: + self.reference_type = reference_type + if name is not None: + self.name = name + if state is not None: + self.state = state + if active_thread_count is not None: + self.active_thread_count = active_thread_count + if validation_errors is not None: + self.validation_errors = validation_errors + if currently_valid is not None: + self.currently_valid = currently_valid + if results_valid is not None: + self.results_valid = results_valid + if resultant_validation_errors is not None: + self.resultant_validation_errors = resultant_validation_errors + + @property + def process_group_id(self): + """ + Gets the process_group_id of this ComponentValidationResultDTO. + The UUID of the Process Group that this component is in + + :return: The process_group_id of this ComponentValidationResultDTO. + :rtype: str + """ + return self._process_group_id + + @process_group_id.setter + def process_group_id(self, process_group_id): + """ + Sets the process_group_id of this ComponentValidationResultDTO. + The UUID of the Process Group that this component is in + + :param process_group_id: The process_group_id of this ComponentValidationResultDTO. + :type: str + """ + + self._process_group_id = process_group_id + + @property + def id(self): + """ + Gets the id of this ComponentValidationResultDTO. + The UUID of this component + + :return: The id of this ComponentValidationResultDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ComponentValidationResultDTO. + The UUID of this component + + :param id: The id of this ComponentValidationResultDTO. + :type: str + """ + + self._id = id + + @property + def reference_type(self): + """ + Gets the reference_type of this ComponentValidationResultDTO. + The type of this component + + :return: The reference_type of this ComponentValidationResultDTO. + :rtype: str + """ + return self._reference_type + + @reference_type.setter + def reference_type(self, reference_type): + """ + Sets the reference_type of this ComponentValidationResultDTO. + The type of this component + + :param reference_type: The reference_type of this ComponentValidationResultDTO. + :type: str + """ + allowed_values = ["PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT"] + if reference_type not in allowed_values: + raise ValueError( + "Invalid value for `reference_type` ({0}), must be one of {1}" + .format(reference_type, allowed_values) + ) + + self._reference_type = reference_type + + @property + def name(self): + """ + Gets the name of this ComponentValidationResultDTO. + The name of this component. + + :return: The name of this ComponentValidationResultDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ComponentValidationResultDTO. + The name of this component. + + :param name: The name of this ComponentValidationResultDTO. + :type: str + """ + + self._name = name + + @property + def state(self): + """ + Gets the state of this ComponentValidationResultDTO. + 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. + + :return: The state of this ComponentValidationResultDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ComponentValidationResultDTO. + 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. + + :param state: The state of this ComponentValidationResultDTO. + :type: str + """ + + self._state = state + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this ComponentValidationResultDTO. + The number of active threads for the referencing component. + + :return: The active_thread_count of this ComponentValidationResultDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ComponentValidationResultDTO. + The number of active threads for the referencing component. + + :param active_thread_count: The active_thread_count of this ComponentValidationResultDTO. + :type: int + """ + + self._active_thread_count = active_thread_count + + @property + def validation_errors(self): + """ + Gets the validation_errors of this ComponentValidationResultDTO. + The validation errors for the component. + + :return: The validation_errors of this ComponentValidationResultDTO. + :rtype: list[str] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """ + Sets the validation_errors of this ComponentValidationResultDTO. + The validation errors for the component. + + :param validation_errors: The validation_errors of this ComponentValidationResultDTO. + :type: list[str] + """ + + self._validation_errors = validation_errors + + @property + def currently_valid(self): + """ + Gets the currently_valid of this ComponentValidationResultDTO. + Whether or not the component is currently valid + + :return: The currently_valid of this ComponentValidationResultDTO. + :rtype: bool + """ + return self._currently_valid + + @currently_valid.setter + def currently_valid(self, currently_valid): + """ + Sets the currently_valid of this ComponentValidationResultDTO. + Whether or not the component is currently valid + + :param currently_valid: The currently_valid of this ComponentValidationResultDTO. + :type: bool + """ + + self._currently_valid = currently_valid + + @property + def results_valid(self): + """ + Gets the results_valid of this ComponentValidationResultDTO. + Whether or not the component will be valid if the Parameter Context is changed + + :return: The results_valid of this ComponentValidationResultDTO. + :rtype: bool + """ + return self._results_valid + + @results_valid.setter + def results_valid(self, results_valid): + """ + Sets the results_valid of this ComponentValidationResultDTO. + Whether or not the component will be valid if the Parameter Context is changed + + :param results_valid: The results_valid of this ComponentValidationResultDTO. + :type: bool + """ + + self._results_valid = results_valid + + @property + def resultant_validation_errors(self): + """ + Gets the resultant_validation_errors of this ComponentValidationResultDTO. + The validation errors that will apply to the component if the Parameter Context is changed + + :return: The resultant_validation_errors of this ComponentValidationResultDTO. + :rtype: list[str] + """ + return self._resultant_validation_errors + + @resultant_validation_errors.setter + def resultant_validation_errors(self, resultant_validation_errors): + """ + Sets the resultant_validation_errors of this ComponentValidationResultDTO. + The validation errors that will apply to the component if the Parameter Context is changed + + :param resultant_validation_errors: The resultant_validation_errors of this ComponentValidationResultDTO. + :type: list[str] + """ + + self._resultant_validation_errors = resultant_validation_errors + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ComponentValidationResultDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/component_validation_result_entity.py b/nipyapi/nifi/models/component_validation_result_entity.py new file mode 100644 index 00000000..71630e71 --- /dev/null +++ b/nipyapi/nifi/models/component_validation_result_entity.py @@ -0,0 +1,319 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ComponentValidationResultEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'revision': 'RevisionDTO', + 'id': 'str', + 'uri': 'str', + 'position': 'PositionDTO', + 'permissions': 'PermissionsDTO', + 'bulletins': 'list[BulletinEntity]', + 'disconnected_node_acknowledged': 'bool', + 'component': 'ComponentValidationResultDTO' + } + + attribute_map = { + 'revision': 'revision', + 'id': 'id', + 'uri': 'uri', + 'position': 'position', + 'permissions': 'permissions', + 'bulletins': 'bulletins', + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', + 'component': 'component' + } + + def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + """ + ComponentValidationResultEntity - a model defined in Swagger + """ + + self._revision = None + self._id = None + self._uri = None + self._position = None + self._permissions = None + self._bulletins = None + self._disconnected_node_acknowledged = None + self._component = None + + if revision is not None: + self.revision = revision + if id is not None: + self.id = id + if uri is not None: + self.uri = uri + if position is not None: + self.position = position + if permissions is not None: + self.permissions = permissions + if bulletins is not None: + self.bulletins = bulletins + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if component is not None: + self.component = component + + @property + def revision(self): + """ + Gets the revision of this ComponentValidationResultEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :return: The revision of this ComponentValidationResultEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ComponentValidationResultEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :param revision: The revision of this ComponentValidationResultEntity. + :type: RevisionDTO + """ + + self._revision = revision + + @property + def id(self): + """ + Gets the id of this ComponentValidationResultEntity. + The id of the component. + + :return: The id of this ComponentValidationResultEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ComponentValidationResultEntity. + The id of the component. + + :param id: The id of this ComponentValidationResultEntity. + :type: str + """ + + self._id = id + + @property + def uri(self): + """ + Gets the uri of this ComponentValidationResultEntity. + The URI for futures requests to the component. + + :return: The uri of this ComponentValidationResultEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ComponentValidationResultEntity. + The URI for futures requests to the component. + + :param uri: The uri of this ComponentValidationResultEntity. + :type: str + """ + + self._uri = uri + + @property + def position(self): + """ + Gets the position of this ComponentValidationResultEntity. + The position of this component in the UI if applicable. + + :return: The position of this ComponentValidationResultEntity. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this ComponentValidationResultEntity. + The position of this component in the UI if applicable. + + :param position: The position of this ComponentValidationResultEntity. + :type: PositionDTO + """ + + self._position = position + + @property + def permissions(self): + """ + Gets the permissions of this ComponentValidationResultEntity. + The permissions for this component. + + :return: The permissions of this ComponentValidationResultEntity. + :rtype: PermissionsDTO + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ComponentValidationResultEntity. + The permissions for this component. + + :param permissions: The permissions of this ComponentValidationResultEntity. + :type: PermissionsDTO + """ + + self._permissions = permissions + + @property + def bulletins(self): + """ + Gets the bulletins of this ComponentValidationResultEntity. + The bulletins for this component. + + :return: The bulletins of this ComponentValidationResultEntity. + :rtype: list[BulletinEntity] + """ + return self._bulletins + + @bulletins.setter + def bulletins(self, bulletins): + """ + Sets the bulletins of this ComponentValidationResultEntity. + The bulletins for this component. + + :param bulletins: The bulletins of this ComponentValidationResultEntity. + :type: list[BulletinEntity] + """ + + self._bulletins = bulletins + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ComponentValidationResultEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ComponentValidationResultEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ComponentValidationResultEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ComponentValidationResultEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def component(self): + """ + Gets the component of this ComponentValidationResultEntity. + + :return: The component of this ComponentValidationResultEntity. + :rtype: ComponentValidationResultDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ComponentValidationResultEntity. + + :param component: The component of this ComponentValidationResultEntity. + :type: ComponentValidationResultDTO + """ + + self._component = component + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ComponentValidationResultEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/component_validation_results_entity.py b/nipyapi/nifi/models/component_validation_results_entity.py new file mode 100644 index 00000000..70a64faf --- /dev/null +++ b/nipyapi/nifi/models/component_validation_results_entity.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ComponentValidationResultsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'validation_results': 'list[ComponentValidationResultEntity]' + } + + attribute_map = { + 'validation_results': 'validationResults' + } + + def __init__(self, validation_results=None): + """ + ComponentValidationResultsEntity - a model defined in Swagger + """ + + self._validation_results = None + + if validation_results is not None: + self.validation_results = validation_results + + @property + def validation_results(self): + """ + Gets the validation_results of this ComponentValidationResultsEntity. + A List of ComponentValidationResultEntity, one for each component that is validated + + :return: The validation_results of this ComponentValidationResultsEntity. + :rtype: list[ComponentValidationResultEntity] + """ + return self._validation_results + + @validation_results.setter + def validation_results(self, validation_results): + """ + Sets the validation_results of this ComponentValidationResultsEntity. + A List of ComponentValidationResultEntity, one for each component that is validated + + :param validation_results: The validation_results of this ComponentValidationResultsEntity. + :type: list[ComponentValidationResultEntity] + """ + + self._validation_results = validation_results + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ComponentValidationResultsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connectable_component.py b/nipyapi/nifi/models/connectable_component.py index fe2e1956..ee49dcc6 100644 --- a/nipyapi/nifi/models/connectable_component.py +++ b/nipyapi/nifi/models/connectable_component.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_dto.py b/nipyapi/nifi/models/connectable_dto.py index 115edcde..72cbc9dd 100644 --- a/nipyapi/nifi/models/connectable_dto.py +++ b/nipyapi/nifi/models/connectable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_dto.py b/nipyapi/nifi/models/connection_dto.py index e401e99a..15d5e001 100644 --- a/nipyapi/nifi/models/connection_dto.py +++ b/nipyapi/nifi/models/connection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_entity.py b/nipyapi/nifi/models/connection_entity.py index 6c60cb6c..c48cd824 100644 --- a/nipyapi/nifi/models/connection_entity.py +++ b/nipyapi/nifi/models/connection_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_dto.py b/nipyapi/nifi/models/connection_statistics_dto.py new file mode 100644 index 00000000..2003b318 --- /dev/null +++ b/nipyapi/nifi/models/connection_statistics_dto.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatisticsDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'stats_last_refreshed': 'str', + 'aggregate_snapshot': 'ConnectionStatisticsSnapshotDTO', + 'node_snapshots': 'list[NodeConnectionStatisticsSnapshotDTO]' + } + + attribute_map = { + 'id': 'id', + 'stats_last_refreshed': 'statsLastRefreshed', + 'aggregate_snapshot': 'aggregateSnapshot', + 'node_snapshots': 'nodeSnapshots' + } + + def __init__(self, id=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None): + """ + ConnectionStatisticsDTO - a model defined in Swagger + """ + + self._id = None + self._stats_last_refreshed = None + self._aggregate_snapshot = None + self._node_snapshots = None + + if id is not None: + self.id = id + if stats_last_refreshed is not None: + self.stats_last_refreshed = stats_last_refreshed + if aggregate_snapshot is not None: + self.aggregate_snapshot = aggregate_snapshot + if node_snapshots is not None: + self.node_snapshots = node_snapshots + + @property + def id(self): + """ + Gets the id of this ConnectionStatisticsDTO. + The ID of the connection + + :return: The id of this ConnectionStatisticsDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ConnectionStatisticsDTO. + The ID of the connection + + :param id: The id of this ConnectionStatisticsDTO. + :type: str + """ + + self._id = id + + @property + def stats_last_refreshed(self): + """ + Gets the stats_last_refreshed of this ConnectionStatisticsDTO. + The timestamp of when the stats were last refreshed + + :return: The stats_last_refreshed of this ConnectionStatisticsDTO. + :rtype: str + """ + return self._stats_last_refreshed + + @stats_last_refreshed.setter + def stats_last_refreshed(self, stats_last_refreshed): + """ + Sets the stats_last_refreshed of this ConnectionStatisticsDTO. + The timestamp of when the stats were last refreshed + + :param stats_last_refreshed: The stats_last_refreshed of this ConnectionStatisticsDTO. + :type: str + """ + + self._stats_last_refreshed = stats_last_refreshed + + @property + def aggregate_snapshot(self): + """ + Gets the aggregate_snapshot of this ConnectionStatisticsDTO. + The status snapshot that represents the aggregate stats of the cluster + + :return: The aggregate_snapshot of this ConnectionStatisticsDTO. + :rtype: ConnectionStatisticsSnapshotDTO + """ + return self._aggregate_snapshot + + @aggregate_snapshot.setter + def aggregate_snapshot(self, aggregate_snapshot): + """ + Sets the aggregate_snapshot of this ConnectionStatisticsDTO. + The status snapshot that represents the aggregate stats of the cluster + + :param aggregate_snapshot: The aggregate_snapshot of this ConnectionStatisticsDTO. + :type: ConnectionStatisticsSnapshotDTO + """ + + self._aggregate_snapshot = aggregate_snapshot + + @property + def node_snapshots(self): + """ + Gets the node_snapshots of this ConnectionStatisticsDTO. + A list of status snapshots for each node + + :return: The node_snapshots of this ConnectionStatisticsDTO. + :rtype: list[NodeConnectionStatisticsSnapshotDTO] + """ + return self._node_snapshots + + @node_snapshots.setter + def node_snapshots(self, node_snapshots): + """ + Sets the node_snapshots of this ConnectionStatisticsDTO. + A list of status snapshots for each node + + :param node_snapshots: The node_snapshots of this ConnectionStatisticsDTO. + :type: list[NodeConnectionStatisticsSnapshotDTO] + """ + + self._node_snapshots = node_snapshots + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatisticsDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_statistics_entity.py b/nipyapi/nifi/models/connection_statistics_entity.py new file mode 100644 index 00000000..cd6a18d5 --- /dev/null +++ b/nipyapi/nifi/models/connection_statistics_entity.py @@ -0,0 +1,151 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatisticsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'connection_statistics': 'ConnectionStatisticsDTO', + 'can_read': 'bool' + } + + attribute_map = { + 'connection_statistics': 'connectionStatistics', + 'can_read': 'canRead' + } + + def __init__(self, connection_statistics=None, can_read=None): + """ + ConnectionStatisticsEntity - a model defined in Swagger + """ + + self._connection_statistics = None + self._can_read = None + + if connection_statistics is not None: + self.connection_statistics = connection_statistics + if can_read is not None: + self.can_read = can_read + + @property + def connection_statistics(self): + """ + Gets the connection_statistics of this ConnectionStatisticsEntity. + + :return: The connection_statistics of this ConnectionStatisticsEntity. + :rtype: ConnectionStatisticsDTO + """ + return self._connection_statistics + + @connection_statistics.setter + def connection_statistics(self, connection_statistics): + """ + Sets the connection_statistics of this ConnectionStatisticsEntity. + + :param connection_statistics: The connection_statistics of this ConnectionStatisticsEntity. + :type: ConnectionStatisticsDTO + """ + + self._connection_statistics = connection_statistics + + @property + def can_read(self): + """ + Gets the can_read of this ConnectionStatisticsEntity. + Indicates whether the user can read a given resource. + + :return: The can_read of this ConnectionStatisticsEntity. + :rtype: bool + """ + return self._can_read + + @can_read.setter + def can_read(self, can_read): + """ + Sets the can_read of this ConnectionStatisticsEntity. + Indicates whether the user can read a given resource. + + :param can_read: The can_read of this ConnectionStatisticsEntity. + :type: bool + """ + + self._can_read = can_read + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatisticsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py new file mode 100644 index 00000000..98524fec --- /dev/null +++ b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py @@ -0,0 +1,321 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatisticsSnapshotDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'predicted_millis_until_count_backpressure': 'int', + 'predicted_millis_until_bytes_backpressure': 'int', + 'predicted_count_at_next_interval': 'int', + 'predicted_bytes_at_next_interval': 'int', + 'predicted_percent_count': 'int', + 'predicted_percent_bytes': 'int', + 'prediction_interval_millis': 'int' + } + + attribute_map = { + 'id': 'id', + 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', + 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', + 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', + 'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', + 'predicted_percent_count': 'predictedPercentCount', + 'predicted_percent_bytes': 'predictedPercentBytes', + 'prediction_interval_millis': 'predictionIntervalMillis' + } + + def __init__(self, id=None, predicted_millis_until_count_backpressure=None, predicted_millis_until_bytes_backpressure=None, predicted_count_at_next_interval=None, predicted_bytes_at_next_interval=None, predicted_percent_count=None, predicted_percent_bytes=None, prediction_interval_millis=None): + """ + ConnectionStatisticsSnapshotDTO - a model defined in Swagger + """ + + self._id = None + self._predicted_millis_until_count_backpressure = None + self._predicted_millis_until_bytes_backpressure = None + self._predicted_count_at_next_interval = None + self._predicted_bytes_at_next_interval = None + self._predicted_percent_count = None + self._predicted_percent_bytes = None + self._prediction_interval_millis = None + + if id is not None: + self.id = id + if predicted_millis_until_count_backpressure is not None: + self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + if predicted_millis_until_bytes_backpressure is not None: + self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + if predicted_count_at_next_interval is not None: + self.predicted_count_at_next_interval = predicted_count_at_next_interval + if predicted_bytes_at_next_interval is not None: + self.predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + if predicted_percent_count is not None: + self.predicted_percent_count = predicted_percent_count + if predicted_percent_bytes is not None: + self.predicted_percent_bytes = predicted_percent_bytes + if prediction_interval_millis is not None: + self.prediction_interval_millis = prediction_interval_millis + + @property + def id(self): + """ + Gets the id of this ConnectionStatisticsSnapshotDTO. + The id of the connection. + + :return: The id of this ConnectionStatisticsSnapshotDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ConnectionStatisticsSnapshotDTO. + The id of the connection. + + :param id: The id of this ConnectionStatisticsSnapshotDTO. + :type: str + """ + + self._id = id + + @property + def predicted_millis_until_count_backpressure(self): + """ + Gets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :return: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_count_backpressure + + @predicted_millis_until_count_backpressure.setter + def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): + """ + Sets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + + @property + def predicted_millis_until_bytes_backpressure(self): + """ + Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_bytes_backpressure + + @predicted_millis_until_bytes_backpressure.setter + def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): + """ + Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + + @property + def predicted_count_at_next_interval(self): + """ + Gets the predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :return: The predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_count_at_next_interval + + @predicted_count_at_next_interval.setter + def predicted_count_at_next_interval(self, predicted_count_at_next_interval): + """ + Sets the predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :param predicted_count_at_next_interval: The predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_count_at_next_interval = predicted_count_at_next_interval + + @property + def predicted_bytes_at_next_interval(self): + """ + Gets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :return: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_bytes_at_next_interval + + @predicted_bytes_at_next_interval.setter + def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): + """ + Sets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + + @property + def predicted_percent_count(self): + """ + Gets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of queued objects at the next configured interval. + + :return: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_count + + @predicted_percent_count.setter + def predicted_percent_count(self, predicted_percent_count): + """ + Sets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of queued objects at the next configured interval. + + :param predicted_percent_count: The predicted_percent_count of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_percent_count = predicted_percent_count + + @property + def predicted_percent_bytes(self): + """ + Gets the predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of bytes in the queue against current threshold at the next configured interval. + + :return: The predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_bytes + + @predicted_percent_bytes.setter + def predicted_percent_bytes(self, predicted_percent_bytes): + """ + Sets the predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + The predicted percentage of bytes in the queue against current threshold at the next configured interval. + + :param predicted_percent_bytes: The predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._predicted_percent_bytes = predicted_percent_bytes + + @property + def prediction_interval_millis(self): + """ + Gets the prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + The prediction interval in seconds + + :return: The prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._prediction_interval_millis + + @prediction_interval_millis.setter + def prediction_interval_millis(self, prediction_interval_millis): + """ + Sets the prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + The prediction interval in seconds + + :param prediction_interval_millis: The prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._prediction_interval_millis = prediction_interval_millis + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatisticsSnapshotDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_status_dto.py b/nipyapi/nifi/models/connection_status_dto.py index ae86ad22..81a5bffa 100644 --- a/nipyapi/nifi/models/connection_status_dto.py +++ b/nipyapi/nifi/models/connection_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_entity.py b/nipyapi/nifi/models/connection_status_entity.py index e1fe4431..78a92039 100644 --- a/nipyapi/nifi/models/connection_status_entity.py +++ b/nipyapi/nifi/models/connection_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py new file mode 100644 index 00000000..b0f0c195 --- /dev/null +++ b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ConnectionStatusPredictionsSnapshotDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'predicted_millis_until_count_backpressure': 'int', + 'predicted_millis_until_bytes_backpressure': 'int', + 'prediction_interval_seconds': 'int', + 'predicted_count_at_next_interval': 'int', + 'predicted_bytes_at_next_interval': 'int', + 'predicted_percent_count': 'int', + 'predicted_percent_bytes': 'int' + } + + attribute_map = { + 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', + 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', + 'prediction_interval_seconds': 'predictionIntervalSeconds', + 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', + 'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', + 'predicted_percent_count': 'predictedPercentCount', + 'predicted_percent_bytes': 'predictedPercentBytes' + } + + def __init__(self, predicted_millis_until_count_backpressure=None, predicted_millis_until_bytes_backpressure=None, prediction_interval_seconds=None, predicted_count_at_next_interval=None, predicted_bytes_at_next_interval=None, predicted_percent_count=None, predicted_percent_bytes=None): + """ + ConnectionStatusPredictionsSnapshotDTO - a model defined in Swagger + """ + + self._predicted_millis_until_count_backpressure = None + self._predicted_millis_until_bytes_backpressure = None + self._prediction_interval_seconds = None + self._predicted_count_at_next_interval = None + self._predicted_bytes_at_next_interval = None + self._predicted_percent_count = None + self._predicted_percent_bytes = None + + if predicted_millis_until_count_backpressure is not None: + self.predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + if predicted_millis_until_bytes_backpressure is not None: + self.predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + if prediction_interval_seconds is not None: + self.prediction_interval_seconds = prediction_interval_seconds + if predicted_count_at_next_interval is not None: + self.predicted_count_at_next_interval = predicted_count_at_next_interval + if predicted_bytes_at_next_interval is not None: + self.predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + if predicted_percent_count is not None: + self.predicted_percent_count = predicted_percent_count + if predicted_percent_bytes is not None: + self.predicted_percent_bytes = predicted_percent_bytes + + @property + def predicted_millis_until_count_backpressure(self): + """ + Gets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :return: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_count_backpressure + + @predicted_millis_until_count_backpressure.setter + def predicted_millis_until_count_backpressure(self, predicted_millis_until_count_backpressure): + """ + Sets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count. + + :param predicted_millis_until_count_backpressure: The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_count_backpressure = predicted_millis_until_count_backpressure + + @property + def predicted_millis_until_bytes_backpressure(self): + """ + Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :return: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_millis_until_bytes_backpressure + + @predicted_millis_until_bytes_backpressure.setter + def predicted_millis_until_bytes_backpressure(self, predicted_millis_until_bytes_backpressure): + """ + Sets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue. + + :param predicted_millis_until_bytes_backpressure: The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_millis_until_bytes_backpressure = predicted_millis_until_bytes_backpressure + + @property + def prediction_interval_seconds(self): + """ + Gets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + The configured interval (in seconds) for predicting connection queue count and size (and percent usage). + + :return: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._prediction_interval_seconds + + @prediction_interval_seconds.setter + def prediction_interval_seconds(self, prediction_interval_seconds): + """ + Sets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + The configured interval (in seconds) for predicting connection queue count and size (and percent usage). + + :param prediction_interval_seconds: The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._prediction_interval_seconds = prediction_interval_seconds + + @property + def predicted_count_at_next_interval(self): + """ + Gets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :return: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_count_at_next_interval + + @predicted_count_at_next_interval.setter + def predicted_count_at_next_interval(self, predicted_count_at_next_interval): + """ + Sets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted number of queued objects at the next configured interval. + + :param predicted_count_at_next_interval: The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_count_at_next_interval = predicted_count_at_next_interval + + @property + def predicted_bytes_at_next_interval(self): + """ + Gets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :return: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_bytes_at_next_interval + + @predicted_bytes_at_next_interval.setter + def predicted_bytes_at_next_interval(self, predicted_bytes_at_next_interval): + """ + Sets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + The predicted total number of bytes in the queue at the next configured interval. + + :param predicted_bytes_at_next_interval: The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_bytes_at_next_interval = predicted_bytes_at_next_interval + + @property + def predicted_percent_count(self): + """ + Gets the predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files count and backpressure threshold if configured. + + :return: The predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_count + + @predicted_percent_count.setter + def predicted_percent_count(self, predicted_percent_count): + """ + Sets the predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files count and backpressure threshold if configured. + + :param predicted_percent_count: The predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_percent_count = predicted_percent_count + + @property + def predicted_percent_bytes(self): + """ + Gets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. + + :return: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + :rtype: int + """ + return self._predicted_percent_bytes + + @predicted_percent_bytes.setter + def predicted_percent_bytes(self, predicted_percent_bytes): + """ + Sets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + Predicted connection percent use regarding queued flow files size and backpressure threshold if configured. + + :param predicted_percent_bytes: The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. + :type: int + """ + + self._predicted_percent_bytes = predicted_percent_bytes + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ConnectionStatusPredictionsSnapshotDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/connection_status_snapshot_dto.py b/nipyapi/nifi/models/connection_status_snapshot_dto.py index 60d37bee..69cf8c94 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,6 +38,7 @@ class ConnectionStatusSnapshotDTO(object): 'source_name': 'str', 'destination_id': 'str', 'destination_name': 'str', + 'predictions': 'ConnectionStatusPredictionsSnapshotDTO', 'flow_files_in': 'int', 'bytes_in': 'int', 'input': 'str', @@ -61,6 +62,7 @@ class ConnectionStatusSnapshotDTO(object): 'source_name': 'sourceName', 'destination_id': 'destinationId', 'destination_name': 'destinationName', + 'predictions': 'predictions', 'flow_files_in': 'flowFilesIn', 'bytes_in': 'bytesIn', 'input': 'input', @@ -76,7 +78,7 @@ class ConnectionStatusSnapshotDTO(object): 'percent_use_bytes': 'percentUseBytes' } - def __init__(self, id=None, group_id=None, name=None, source_id=None, source_name=None, destination_id=None, destination_name=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): + def __init__(self, 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): """ ConnectionStatusSnapshotDTO - a model defined in Swagger """ @@ -88,6 +90,7 @@ def __init__(self, id=None, group_id=None, name=None, source_id=None, source_nam self._source_name = None self._destination_id = None self._destination_name = None + self._predictions = None self._flow_files_in = None self._bytes_in = None self._input = None @@ -116,6 +119,8 @@ def __init__(self, id=None, group_id=None, name=None, source_id=None, source_nam self.destination_id = destination_id if destination_name is not None: self.destination_name = destination_name + if predictions is not None: + self.predictions = predictions if flow_files_in is not None: self.flow_files_in = flow_files_in if bytes_in is not None: @@ -304,6 +309,29 @@ def destination_name(self, destination_name): self._destination_name = destination_name + @property + def predictions(self): + """ + Gets the predictions of this ConnectionStatusSnapshotDTO. + Predictions, if available, for this connection (null if not available) + + :return: The predictions of this ConnectionStatusSnapshotDTO. + :rtype: ConnectionStatusPredictionsSnapshotDTO + """ + return self._predictions + + @predictions.setter + def predictions(self, predictions): + """ + Sets the predictions of this ConnectionStatusSnapshotDTO. + Predictions, if available, for this connection (null if not available) + + :param predictions: The predictions of this ConnectionStatusSnapshotDTO. + :type: ConnectionStatusPredictionsSnapshotDTO + """ + + self._predictions = predictions + @property def flow_files_in(self): """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_entity.py b/nipyapi/nifi/models/connection_status_snapshot_entity.py index 58b3e42a..efc4d104 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_entity.py +++ b/nipyapi/nifi/models/connection_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connections_entity.py b/nipyapi/nifi/models/connections_entity.py index a0694bcf..6c4dc8c2 100644 --- a/nipyapi/nifi/models/connections_entity.py +++ b/nipyapi/nifi/models/connections_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_bulletins_entity.py b/nipyapi/nifi/models/controller_bulletins_entity.py index 73be4e70..91d1279b 100644 --- a/nipyapi/nifi/models/controller_bulletins_entity.py +++ b/nipyapi/nifi/models/controller_bulletins_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_dto.py b/nipyapi/nifi/models/controller_configuration_dto.py index 4a7ec25e..7f9027b8 100644 --- a/nipyapi/nifi/models/controller_configuration_dto.py +++ b/nipyapi/nifi/models/controller_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_entity.py b/nipyapi/nifi/models/controller_configuration_entity.py index 1ec6e09e..bcdf8057 100644 --- a/nipyapi/nifi/models/controller_configuration_entity.py +++ b/nipyapi/nifi/models/controller_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_dto.py b/nipyapi/nifi/models/controller_dto.py index 95d4d454..a6323e65 100644 --- a/nipyapi/nifi/models/controller_dto.py +++ b/nipyapi/nifi/models/controller_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_entity.py b/nipyapi/nifi/models/controller_entity.py index 5a75e56f..6b0425a5 100644 --- a/nipyapi/nifi/models/controller_entity.py +++ b/nipyapi/nifi/models/controller_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api.py b/nipyapi/nifi/models/controller_service_api.py index 5f26195a..2f65f9c2 100644 --- a/nipyapi/nifi/models/controller_service_api.py +++ b/nipyapi/nifi/models/controller_service_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api_dto.py b/nipyapi/nifi/models/controller_service_api_dto.py index d100c51f..df3949db 100644 --- a/nipyapi/nifi/models/controller_service_api_dto.py +++ b/nipyapi/nifi/models/controller_service_api_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_dto.py b/nipyapi/nifi/models/controller_service_dto.py index 21b08196..03b73ce1 100644 --- a/nipyapi/nifi/models/controller_service_dto.py +++ b/nipyapi/nifi/models/controller_service_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_entity.py b/nipyapi/nifi/models/controller_service_entity.py index a762a354..67a556da 100644 --- a/nipyapi/nifi/models/controller_service_entity.py +++ b/nipyapi/nifi/models/controller_service_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index e7fb96fb..0e8d9be1 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -307,7 +307,6 @@ def reference_type(self, reference_type): :param reference_type: The reference_type of this ControllerServiceReferencingComponentDTO. :type: str """ - # allowed_values = ["Processor", "ControllerService", "or ReportingTask"] allowed_values = ["Processor", "ControllerService", "ReportingTask"] if reference_type not in allowed_values: raise ValueError( diff --git a/nipyapi/nifi/models/controller_service_referencing_component_entity.py b/nipyapi/nifi/models/controller_service_referencing_component_entity.py index 519a71df..97f99368 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_components_entity.py b/nipyapi/nifi/models/controller_service_referencing_components_entity.py index 94e0a01a..8e64ba56 100644 --- a/nipyapi/nifi/models/controller_service_referencing_components_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_run_status_entity.py b/nipyapi/nifi/models/controller_service_run_status_entity.py index c5774c39..bf397a0f 100644 --- a/nipyapi/nifi/models/controller_service_run_status_entity.py +++ b/nipyapi/nifi/models/controller_service_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_status_dto.py b/nipyapi/nifi/models/controller_service_status_dto.py index 0ddf7765..29e5f2e5 100644 --- a/nipyapi/nifi/models/controller_service_status_dto.py +++ b/nipyapi/nifi/models/controller_service_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_types_entity.py b/nipyapi/nifi/models/controller_service_types_entity.py index 590efd35..acd601f2 100644 --- a/nipyapi/nifi/models/controller_service_types_entity.py +++ b/nipyapi/nifi/models/controller_service_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_services_entity.py b/nipyapi/nifi/models/controller_services_entity.py index e5bdc6e1..b7808043 100644 --- a/nipyapi/nifi/models/controller_services_entity.py +++ b/nipyapi/nifi/models/controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_dto.py b/nipyapi/nifi/models/controller_status_dto.py index 557ed827..f7080ea2 100644 --- a/nipyapi/nifi/models/controller_status_dto.py +++ b/nipyapi/nifi/models/controller_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_entity.py b/nipyapi/nifi/models/controller_status_entity.py index 98777586..0e4f3ea8 100644 --- a/nipyapi/nifi/models/controller_status_entity.py +++ b/nipyapi/nifi/models/controller_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/copy_snippet_request_entity.py b/nipyapi/nifi/models/copy_snippet_request_entity.py index f2d5d115..65f2161c 100644 --- a/nipyapi/nifi/models/copy_snippet_request_entity.py +++ b/nipyapi/nifi/models/copy_snippet_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_dto.py b/nipyapi/nifi/models/counter_dto.py index edc58139..1599c822 100644 --- a/nipyapi/nifi/models/counter_dto.py +++ b/nipyapi/nifi/models/counter_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_entity.py b/nipyapi/nifi/models/counter_entity.py index ed95c295..283a01fc 100644 --- a/nipyapi/nifi/models/counter_entity.py +++ b/nipyapi/nifi/models/counter_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_dto.py b/nipyapi/nifi/models/counters_dto.py index 66b8f8ba..bf53305c 100644 --- a/nipyapi/nifi/models/counters_dto.py +++ b/nipyapi/nifi/models/counters_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_entity.py b/nipyapi/nifi/models/counters_entity.py index 1edc475b..5b654a09 100644 --- a/nipyapi/nifi/models/counters_entity.py +++ b/nipyapi/nifi/models/counters_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_snapshot_dto.py b/nipyapi/nifi/models/counters_snapshot_dto.py index f2ed4de1..fc3e5c15 100644 --- a/nipyapi/nifi/models/counters_snapshot_dto.py +++ b/nipyapi/nifi/models/counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_active_request_entity.py b/nipyapi/nifi/models/create_active_request_entity.py index 29e3fb4c..4ed96bb0 100644 --- a/nipyapi/nifi/models/create_active_request_entity.py +++ b/nipyapi/nifi/models/create_active_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_template_request_entity.py b/nipyapi/nifi/models/create_template_request_entity.py index bde391e1..0cce1072 100644 --- a/nipyapi/nifi/models/create_template_request_entity.py +++ b/nipyapi/nifi/models/create_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/current_user_entity.py b/nipyapi/nifi/models/current_user_entity.py index ccc5d275..3c821993 100644 --- a/nipyapi/nifi/models/current_user_entity.py +++ b/nipyapi/nifi/models/current_user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -39,6 +39,7 @@ class CurrentUserEntity(object): 'controller_permissions': 'PermissionsDTO', 'policies_permissions': 'PermissionsDTO', 'system_permissions': 'PermissionsDTO', + 'parameter_context_permissions': 'PermissionsDTO', 'restricted_components_permissions': 'PermissionsDTO', 'component_restriction_permissions': 'list[ComponentRestrictionPermissionDTO]', 'can_version_flows': 'bool' @@ -53,12 +54,13 @@ class CurrentUserEntity(object): 'controller_permissions': 'controllerPermissions', 'policies_permissions': 'policiesPermissions', 'system_permissions': 'systemPermissions', + 'parameter_context_permissions': 'parameterContextPermissions', 'restricted_components_permissions': 'restrictedComponentsPermissions', 'component_restriction_permissions': 'componentRestrictionPermissions', 'can_version_flows': 'canVersionFlows' } - def __init__(self, identity=None, anonymous=None, provenance_permissions=None, counters_permissions=None, tenants_permissions=None, controller_permissions=None, policies_permissions=None, system_permissions=None, restricted_components_permissions=None, component_restriction_permissions=None, can_version_flows=None): + def __init__(self, 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): """ CurrentUserEntity - a model defined in Swagger """ @@ -71,6 +73,7 @@ def __init__(self, identity=None, anonymous=None, provenance_permissions=None, c self._controller_permissions = None self._policies_permissions = None self._system_permissions = None + self._parameter_context_permissions = None self._restricted_components_permissions = None self._component_restriction_permissions = None self._can_version_flows = None @@ -91,6 +94,8 @@ def __init__(self, identity=None, anonymous=None, provenance_permissions=None, c self.policies_permissions = policies_permissions if system_permissions is not None: self.system_permissions = system_permissions + if parameter_context_permissions is not None: + self.parameter_context_permissions = parameter_context_permissions if restricted_components_permissions is not None: self.restricted_components_permissions = restricted_components_permissions if component_restriction_permissions is not None: @@ -282,6 +287,29 @@ def system_permissions(self, system_permissions): self._system_permissions = system_permissions + @property + def parameter_context_permissions(self): + """ + Gets the parameter_context_permissions of this CurrentUserEntity. + Permissions for accessing parameter contexts. + + :return: The parameter_context_permissions of this CurrentUserEntity. + :rtype: PermissionsDTO + """ + return self._parameter_context_permissions + + @parameter_context_permissions.setter + def parameter_context_permissions(self, parameter_context_permissions): + """ + Sets the parameter_context_permissions of this CurrentUserEntity. + Permissions for accessing parameter contexts. + + :param parameter_context_permissions: The parameter_context_permissions of this CurrentUserEntity. + :type: PermissionsDTO + """ + + self._parameter_context_permissions = parameter_context_permissions + @property def restricted_components_permissions(self): """ diff --git a/nipyapi/nifi/models/difference_dto.py b/nipyapi/nifi/models/difference_dto.py index 85415128..3fe97fd8 100644 --- a/nipyapi/nifi/models/difference_dto.py +++ b/nipyapi/nifi/models/difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dimensions_dto.py b/nipyapi/nifi/models/dimensions_dto.py index 7dee9d4b..41cbce0d 100644 --- a/nipyapi/nifi/models/dimensions_dto.py +++ b/nipyapi/nifi/models/dimensions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/documented_type_dto.py b/nipyapi/nifi/models/documented_type_dto.py index 4d3be02d..231134ec 100644 --- a/nipyapi/nifi/models/documented_type_dto.py +++ b/nipyapi/nifi/models/documented_type_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_dto.py b/nipyapi/nifi/models/drop_request_dto.py index c95c34f6..250e4077 100644 --- a/nipyapi/nifi/models/drop_request_dto.py +++ b/nipyapi/nifi/models/drop_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_entity.py b/nipyapi/nifi/models/drop_request_entity.py index a2ad48c2..cc3f3df7 100644 --- a/nipyapi/nifi/models/drop_request_entity.py +++ b/nipyapi/nifi/models/drop_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/explicit_restriction_dto.py b/nipyapi/nifi/models/explicit_restriction_dto.py index 6464f641..c42d27e9 100644 --- a/nipyapi/nifi/models/explicit_restriction_dto.py +++ b/nipyapi/nifi/models/explicit_restriction_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/external_controller_service_reference.py b/nipyapi/nifi/models/external_controller_service_reference.py new file mode 100644 index 00000000..54689294 --- /dev/null +++ b/nipyapi/nifi/models/external_controller_service_reference.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ExternalControllerServiceReference(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'identifier': 'str', + 'name': 'str' + } + + attribute_map = { + 'identifier': 'identifier', + 'name': 'name' + } + + def __init__(self, identifier=None, name=None): + """ + ExternalControllerServiceReference - a model defined in Swagger + """ + + self._identifier = None + self._name = None + + if identifier is not None: + self.identifier = identifier + if name is not None: + self.name = name + + @property + def identifier(self): + """ + Gets the identifier of this ExternalControllerServiceReference. + The identifier of the controller service + + :return: The identifier of this ExternalControllerServiceReference. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this ExternalControllerServiceReference. + The identifier of the controller service + + :param identifier: The identifier of this ExternalControllerServiceReference. + :type: str + """ + + self._identifier = identifier + + @property + def name(self): + """ + Gets the name of this ExternalControllerServiceReference. + The name of the controller service + + :return: The name of this ExternalControllerServiceReference. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ExternalControllerServiceReference. + The name of the controller service + + :param name: The name of this ExternalControllerServiceReference. + :type: str + """ + + self._name = name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ExternalControllerServiceReference): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/flow_breadcrumb_dto.py b/nipyapi/nifi/models/flow_breadcrumb_dto.py index 7978e7ca..4bb3fccc 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_dto.py +++ b/nipyapi/nifi/models/flow_breadcrumb_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_entity.py b/nipyapi/nifi/models/flow_breadcrumb_entity.py index 88928c06..37ece9f9 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_entity.py +++ b/nipyapi/nifi/models/flow_breadcrumb_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_comparison_entity.py b/nipyapi/nifi/models/flow_comparison_entity.py index 454ffcaf..6ffc4b10 100644 --- a/nipyapi/nifi/models/flow_comparison_entity.py +++ b/nipyapi/nifi/models/flow_comparison_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_dto.py b/nipyapi/nifi/models/flow_configuration_dto.py index e338f1c8..df9fd085 100644 --- a/nipyapi/nifi/models/flow_configuration_dto.py +++ b/nipyapi/nifi/models/flow_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_entity.py b/nipyapi/nifi/models/flow_configuration_entity.py index 5812c601..0ad226de 100644 --- a/nipyapi/nifi/models/flow_configuration_entity.py +++ b/nipyapi/nifi/models/flow_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_dto.py b/nipyapi/nifi/models/flow_dto.py index 2bc1d7fd..60d28e3e 100644 --- a/nipyapi/nifi/models/flow_dto.py +++ b/nipyapi/nifi/models/flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_entity.py b/nipyapi/nifi/models/flow_entity.py index ca3dddda..d67c0175 100644 --- a/nipyapi/nifi/models/flow_entity.py +++ b/nipyapi/nifi/models/flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_dto.py b/nipyapi/nifi/models/flow_file_dto.py index f0dd23f2..f4da0192 100644 --- a/nipyapi/nifi/models/flow_file_dto.py +++ b/nipyapi/nifi/models/flow_file_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_entity.py b/nipyapi/nifi/models/flow_file_entity.py index b146c4f2..c801cb97 100644 --- a/nipyapi/nifi/models/flow_file_entity.py +++ b/nipyapi/nifi/models/flow_file_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_summary_dto.py b/nipyapi/nifi/models/flow_file_summary_dto.py index 135e546a..1cafbdfd 100644 --- a/nipyapi/nifi/models/flow_file_summary_dto.py +++ b/nipyapi/nifi/models/flow_file_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_snippet_dto.py b/nipyapi/nifi/models/flow_snippet_dto.py index 9488c390..335180df 100644 --- a/nipyapi/nifi/models/flow_snippet_dto.py +++ b/nipyapi/nifi/models/flow_snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_dto.py b/nipyapi/nifi/models/funnel_dto.py index 4256f56b..b68d495c 100644 --- a/nipyapi/nifi/models/funnel_dto.py +++ b/nipyapi/nifi/models/funnel_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_entity.py b/nipyapi/nifi/models/funnel_entity.py index 6e0e313d..3594cc5d 100644 --- a/nipyapi/nifi/models/funnel_entity.py +++ b/nipyapi/nifi/models/funnel_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnels_entity.py b/nipyapi/nifi/models/funnels_entity.py index 49d8a429..76031142 100644 --- a/nipyapi/nifi/models/funnels_entity.py +++ b/nipyapi/nifi/models/funnels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/garbage_collection_dto.py b/nipyapi/nifi/models/garbage_collection_dto.py index db373915..ad92cbd3 100644 --- a/nipyapi/nifi/models/garbage_collection_dto.py +++ b/nipyapi/nifi/models/garbage_collection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_dto.py b/nipyapi/nifi/models/history_dto.py index 246c0198..8af6f1f1 100644 --- a/nipyapi/nifi/models/history_dto.py +++ b/nipyapi/nifi/models/history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_entity.py b/nipyapi/nifi/models/history_entity.py index 85578d00..ed06f473 100644 --- a/nipyapi/nifi/models/history_entity.py +++ b/nipyapi/nifi/models/history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/input_ports_entity.py b/nipyapi/nifi/models/input_ports_entity.py index 301b901d..1bb7048d 100644 --- a/nipyapi/nifi/models/input_ports_entity.py +++ b/nipyapi/nifi/models/input_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/instantiate_template_request_entity.py b/nipyapi/nifi/models/instantiate_template_request_entity.py index 37b884ad..a1c39649 100644 --- a/nipyapi/nifi/models/instantiate_template_request_entity.py +++ b/nipyapi/nifi/models/instantiate_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/uri_builder.py b/nipyapi/nifi/models/jaxb_link.py similarity index 64% rename from nipyapi/nifi/models/uri_builder.py rename to nipyapi/nifi/models/jaxb_link.py index 1bd08d62..03acc670 100644 --- a/nipyapi/nifi/models/uri_builder.py +++ b/nipyapi/nifi/models/jaxb_link.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -16,7 +16,7 @@ import re -class UriBuilder(object): +class JaxbLink(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -31,19 +31,73 @@ class UriBuilder(object): and the value is json key in definition. """ swagger_types = { - + 'href': 'str', + 'params': 'dict(str, str)' } attribute_map = { - + 'href': 'href', + 'params': 'params' } - def __init__(self): + def __init__(self, href=None, params=None): """ - UriBuilder - a model defined in Swagger + JaxbLink - a model defined in Swagger """ + self._href = None + self._params = None + if href is not None: + self.href = href + if params is not None: + self.params = params + + @property + def href(self): + """ + Gets the href of this JaxbLink. + The href for the link + + :return: The href of this JaxbLink. + :rtype: str + """ + return self._href + + @href.setter + def href(self, href): + """ + Sets the href of this JaxbLink. + The href for the link + + :param href: The href of this JaxbLink. + :type: str + """ + + self._href = href + + @property + def params(self): + """ + Gets the params of this JaxbLink. + The params for the link + + :return: The params of this JaxbLink. + :rtype: dict(str, str) + """ + return self._params + + @params.setter + def params(self, params): + """ + Sets the params of this JaxbLink. + The params for the link + + :param params: The params of this JaxbLink. + :type: dict(str, str) + """ + + self._params = params def to_dict(self): """ @@ -87,7 +141,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, UriBuilder): + if not isinstance(other, JaxbLink): return False return self.__dict__ == other.__dict__ diff --git a/nipyapi/nifi/models/label_dto.py b/nipyapi/nifi/models/label_dto.py index 4e73d018..e64b0090 100644 --- a/nipyapi/nifi/models/label_dto.py +++ b/nipyapi/nifi/models/label_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_entity.py b/nipyapi/nifi/models/label_entity.py index 50d8f0c8..36f855b6 100644 --- a/nipyapi/nifi/models/label_entity.py +++ b/nipyapi/nifi/models/label_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/labels_entity.py b/nipyapi/nifi/models/labels_entity.py index 0120ab24..162df91b 100644 --- a/nipyapi/nifi/models/labels_entity.py +++ b/nipyapi/nifi/models/labels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_dto.py b/nipyapi/nifi/models/lineage_dto.py index 90edea91..f42a5672 100644 --- a/nipyapi/nifi/models/lineage_dto.py +++ b/nipyapi/nifi/models/lineage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_entity.py b/nipyapi/nifi/models/lineage_entity.py index 30923dbb..88f8d4da 100644 --- a/nipyapi/nifi/models/lineage_entity.py +++ b/nipyapi/nifi/models/lineage_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_request_dto.py b/nipyapi/nifi/models/lineage_request_dto.py index d3919959..bcbb3def 100644 --- a/nipyapi/nifi/models/lineage_request_dto.py +++ b/nipyapi/nifi/models/lineage_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_results_dto.py b/nipyapi/nifi/models/lineage_results_dto.py index 6e4b5fd7..48a5df68 100644 --- a/nipyapi/nifi/models/lineage_results_dto.py +++ b/nipyapi/nifi/models/lineage_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/link.py b/nipyapi/nifi/models/link.py deleted file mode 100644 index 95f2c7e2..00000000 --- a/nipyapi/nifi/models/link.py +++ /dev/null @@ -1,279 +0,0 @@ -# coding: utf-8 - -""" - NiFi Rest Api - - The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - - OpenAPI spec version: 1.9.1 - Contact: dev@nifi.apache.org - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from pprint import pformat -from six import iteritems -import re - - -class Link(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'type': 'str', - 'title': 'str', - 'rel': 'str', - 'rels': 'list[str]', - 'uri_builder': 'UriBuilder', - 'params': 'dict(str, str)', - 'uri': 'str' - } - - attribute_map = { - 'type': 'type', - 'title': 'title', - 'rel': 'rel', - 'rels': 'rels', - 'uri_builder': 'uriBuilder', - 'params': 'params', - 'uri': 'uri' - } - - def __init__(self, type=None, title=None, rel=None, rels=None, uri_builder=None, params=None, uri=None): - """ - Link - a model defined in Swagger - """ - - self._type = None - self._title = None - self._rel = None - self._rels = None - self._uri_builder = None - self._params = None - self._uri = None - - if type is not None: - self.type = type - if title is not None: - self.title = title - if rel is not None: - self.rel = rel - if rels is not None: - self.rels = rels - if uri_builder is not None: - self.uri_builder = uri_builder - if params is not None: - self.params = params - if uri is not None: - self.uri = uri - - @property - def type(self): - """ - Gets the type of this Link. - - :return: The type of this Link. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this Link. - - :param type: The type of this Link. - :type: str - """ - - self._type = type - - @property - def title(self): - """ - Gets the title of this Link. - - :return: The title of this Link. - :rtype: str - """ - return self._title - - @title.setter - def title(self, title): - """ - Sets the title of this Link. - - :param title: The title of this Link. - :type: str - """ - - self._title = title - - @property - def rel(self): - """ - Gets the rel of this Link. - - :return: The rel of this Link. - :rtype: str - """ - return self._rel - - @rel.setter - def rel(self, rel): - """ - Sets the rel of this Link. - - :param rel: The rel of this Link. - :type: str - """ - - self._rel = rel - - @property - def rels(self): - """ - Gets the rels of this Link. - - :return: The rels of this Link. - :rtype: list[str] - """ - return self._rels - - @rels.setter - def rels(self, rels): - """ - Sets the rels of this Link. - - :param rels: The rels of this Link. - :type: list[str] - """ - - self._rels = rels - - @property - def uri_builder(self): - """ - Gets the uri_builder of this Link. - - :return: The uri_builder of this Link. - :rtype: UriBuilder - """ - return self._uri_builder - - @uri_builder.setter - def uri_builder(self, uri_builder): - """ - Sets the uri_builder of this Link. - - :param uri_builder: The uri_builder of this Link. - :type: UriBuilder - """ - - self._uri_builder = uri_builder - - @property - def params(self): - """ - Gets the params of this Link. - - :return: The params of this Link. - :rtype: dict(str, str) - """ - return self._params - - @params.setter - def params(self, params): - """ - Sets the params of this Link. - - :param params: The params of this Link. - :type: dict(str, str) - """ - - self._params = params - - @property - def uri(self): - """ - Gets the uri of this Link. - - :return: The uri of this Link. - :rtype: str - """ - return self._uri - - @uri.setter - def uri(self, uri): - """ - Sets the uri of this Link. - - :param uri: The uri of this Link. - :type: str - """ - - self._uri = uri - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - if not isinstance(other, Link): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/nipyapi/nifi/models/listing_request_dto.py b/nipyapi/nifi/models/listing_request_dto.py index 2decdace..4bf6521e 100644 --- a/nipyapi/nifi/models/listing_request_dto.py +++ b/nipyapi/nifi/models/listing_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/listing_request_entity.py b/nipyapi/nifi/models/listing_request_entity.py index cf3e45e7..e4341608 100644 --- a/nipyapi/nifi/models/listing_request_entity.py +++ b/nipyapi/nifi/models/listing_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py new file mode 100644 index 00000000..de6968ba --- /dev/null +++ b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class NodeConnectionStatisticsSnapshotDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'node_id': 'str', + 'address': 'str', + 'api_port': 'int', + 'statistics_snapshot': 'ConnectionStatisticsSnapshotDTO' + } + + attribute_map = { + 'node_id': 'nodeId', + 'address': 'address', + 'api_port': 'apiPort', + 'statistics_snapshot': 'statisticsSnapshot' + } + + def __init__(self, node_id=None, address=None, api_port=None, statistics_snapshot=None): + """ + NodeConnectionStatisticsSnapshotDTO - a model defined in Swagger + """ + + self._node_id = None + self._address = None + self._api_port = None + self._statistics_snapshot = None + + if node_id is not None: + self.node_id = node_id + if address is not None: + self.address = address + if api_port is not None: + self.api_port = api_port + if statistics_snapshot is not None: + self.statistics_snapshot = statistics_snapshot + + @property + def node_id(self): + """ + Gets the node_id of this NodeConnectionStatisticsSnapshotDTO. + The unique ID that identifies the node + + :return: The node_id of this NodeConnectionStatisticsSnapshotDTO. + :rtype: str + """ + return self._node_id + + @node_id.setter + def node_id(self, node_id): + """ + Sets the node_id of this NodeConnectionStatisticsSnapshotDTO. + The unique ID that identifies the node + + :param node_id: The node_id of this NodeConnectionStatisticsSnapshotDTO. + :type: str + """ + + self._node_id = node_id + + @property + def address(self): + """ + Gets the address of this NodeConnectionStatisticsSnapshotDTO. + The API address of the node + + :return: The address of this NodeConnectionStatisticsSnapshotDTO. + :rtype: str + """ + return self._address + + @address.setter + def address(self, address): + """ + Sets the address of this NodeConnectionStatisticsSnapshotDTO. + The API address of the node + + :param address: The address of this NodeConnectionStatisticsSnapshotDTO. + :type: str + """ + + self._address = address + + @property + def api_port(self): + """ + Gets the api_port of this NodeConnectionStatisticsSnapshotDTO. + The API port used to communicate with the node + + :return: The api_port of this NodeConnectionStatisticsSnapshotDTO. + :rtype: int + """ + return self._api_port + + @api_port.setter + def api_port(self, api_port): + """ + Sets the api_port of this NodeConnectionStatisticsSnapshotDTO. + The API port used to communicate with the node + + :param api_port: The api_port of this NodeConnectionStatisticsSnapshotDTO. + :type: int + """ + + self._api_port = api_port + + @property + def statistics_snapshot(self): + """ + Gets the statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + The connection status snapshot from the node. + + :return: The statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + :rtype: ConnectionStatisticsSnapshotDTO + """ + return self._statistics_snapshot + + @statistics_snapshot.setter + def statistics_snapshot(self, statistics_snapshot): + """ + Sets the statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + The connection status snapshot from the node. + + :param statistics_snapshot: The statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO. + :type: ConnectionStatisticsSnapshotDTO + """ + + self._statistics_snapshot = statistics_snapshot + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, NodeConnectionStatisticsSnapshotDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py index 0a8a8baa..890a1129 100644 --- a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_counters_snapshot_dto.py b/nipyapi/nifi/models/node_counters_snapshot_dto.py index ff82da87..34f2932c 100644 --- a/nipyapi/nifi/models/node_counters_snapshot_dto.py +++ b/nipyapi/nifi/models/node_counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_dto.py b/nipyapi/nifi/models/node_dto.py index b7ea4a7b..bdcad7e2 100644 --- a/nipyapi/nifi/models/node_dto.py +++ b/nipyapi/nifi/models/node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_entity.py b/nipyapi/nifi/models/node_entity.py index f99f64a5..e18b6f8e 100644 --- a/nipyapi/nifi/models/node_entity.py +++ b/nipyapi/nifi/models/node_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_event_dto.py b/nipyapi/nifi/models/node_event_dto.py index d9d91a53..7ce20901 100644 --- a/nipyapi/nifi/models/node_event_dto.py +++ b/nipyapi/nifi/models/node_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_port_status_snapshot_dto.py b/nipyapi/nifi/models/node_port_status_snapshot_dto.py index 74dcd6fc..e5cc20d6 100644 --- a/nipyapi/nifi/models/node_port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py index 736075bd..2adb8225 100644 --- a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py index b0788f82..58238a02 100644 --- a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py index 85178122..f4238dab 100644 --- a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_search_result_dto.py b/nipyapi/nifi/models/node_search_result_dto.py index d69944ff..0bb54c11 100644 --- a/nipyapi/nifi/models/node_search_result_dto.py +++ b/nipyapi/nifi/models/node_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_status_snapshots_dto.py b/nipyapi/nifi/models/node_status_snapshots_dto.py index befd2c6d..3f387047 100644 --- a/nipyapi/nifi/models/node_status_snapshots_dto.py +++ b/nipyapi/nifi/models/node_status_snapshots_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py index 9daacf80..d6dacd20 100644 --- a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/output_ports_entity.py b/nipyapi/nifi/models/output_ports_entity.py index 3da899f1..87cfe258 100644 --- a/nipyapi/nifi/models/output_ports_entity.py +++ b/nipyapi/nifi/models/output_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_dto.py b/nipyapi/nifi/models/parameter_context_dto.py new file mode 100644 index 00000000..782aa577 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_dto.py @@ -0,0 +1,237 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'parameters': 'list[ParameterEntity]', + 'bound_process_groups': 'list[ProcessGroupEntity]', + 'id': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'parameters': 'parameters', + 'bound_process_groups': 'boundProcessGroups', + 'id': 'id' + } + + def __init__(self, name=None, description=None, parameters=None, bound_process_groups=None, id=None): + """ + ParameterContextDTO - a model defined in Swagger + """ + + self._name = None + self._description = None + self._parameters = None + self._bound_process_groups = None + self._id = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if parameters is not None: + self.parameters = parameters + if bound_process_groups is not None: + self.bound_process_groups = bound_process_groups + if id is not None: + self.id = id + + @property + def name(self): + """ + Gets the name of this ParameterContextDTO. + The Name of the Parameter Context. + + :return: The name of this ParameterContextDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ParameterContextDTO. + The Name of the Parameter Context. + + :param name: The name of this ParameterContextDTO. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this ParameterContextDTO. + The Description of the Parameter Context. + + :return: The description of this ParameterContextDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextDTO. + The Description of the Parameter Context. + + :param description: The description of this ParameterContextDTO. + :type: str + """ + + self._description = description + + @property + def parameters(self): + """ + Gets the parameters of this ParameterContextDTO. + The Parameters for the Parameter Context + + :return: The parameters of this ParameterContextDTO. + :rtype: list[ParameterEntity] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this ParameterContextDTO. + The Parameters for the Parameter Context + + :param parameters: The parameters of this ParameterContextDTO. + :type: list[ParameterEntity] + """ + + self._parameters = parameters + + @property + def bound_process_groups(self): + """ + Gets the bound_process_groups of this ParameterContextDTO. + The Process Groups that are bound to this Parameter Context + + :return: The bound_process_groups of this ParameterContextDTO. + :rtype: list[ProcessGroupEntity] + """ + return self._bound_process_groups + + @bound_process_groups.setter + def bound_process_groups(self, bound_process_groups): + """ + Sets the bound_process_groups of this ParameterContextDTO. + The Process Groups that are bound to this Parameter Context + + :param bound_process_groups: The bound_process_groups of this ParameterContextDTO. + :type: list[ProcessGroupEntity] + """ + + self._bound_process_groups = bound_process_groups + + @property + def id(self): + """ + Gets the id of this ParameterContextDTO. + The ID the Parameter Context. + + :return: The id of this ParameterContextDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextDTO. + The ID the Parameter Context. + + :param id: The id of this ParameterContextDTO. + :type: str + """ + + self._id = id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_entity.py b/nipyapi/nifi/models/parameter_context_entity.py new file mode 100644 index 00000000..f1e2314a --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_entity.py @@ -0,0 +1,321 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'revision': 'RevisionDTO', + 'id': 'str', + 'uri': 'str', + 'position': 'PositionDTO', + 'permissions': 'PermissionsDTO', + 'bulletins': 'list[BulletinEntity]', + 'disconnected_node_acknowledged': 'bool', + 'component': 'ParameterContextDTO' + } + + attribute_map = { + 'revision': 'revision', + 'id': 'id', + 'uri': 'uri', + 'position': 'position', + 'permissions': 'permissions', + 'bulletins': 'bulletins', + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', + 'component': 'component' + } + + def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None): + """ + ParameterContextEntity - a model defined in Swagger + """ + + self._revision = None + self._id = None + self._uri = None + self._position = None + self._permissions = None + self._bulletins = None + self._disconnected_node_acknowledged = None + self._component = None + + if revision is not None: + self.revision = revision + if id is not None: + self.id = id + if uri is not None: + self.uri = uri + if position is not None: + self.position = position + if permissions is not None: + self.permissions = permissions + if bulletins is not None: + self.bulletins = bulletins + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if component is not None: + self.component = component + + @property + def revision(self): + """ + Gets the revision of this ParameterContextEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :return: The revision of this ParameterContextEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ParameterContextEntity. + The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses. + + :param revision: The revision of this ParameterContextEntity. + :type: RevisionDTO + """ + + self._revision = revision + + @property + def id(self): + """ + Gets the id of this ParameterContextEntity. + The id of the component. + + :return: The id of this ParameterContextEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextEntity. + The id of the component. + + :param id: The id of this ParameterContextEntity. + :type: str + """ + + self._id = id + + @property + def uri(self): + """ + Gets the uri of this ParameterContextEntity. + The URI for futures requests to the component. + + :return: The uri of this ParameterContextEntity. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ParameterContextEntity. + The URI for futures requests to the component. + + :param uri: The uri of this ParameterContextEntity. + :type: str + """ + + self._uri = uri + + @property + def position(self): + """ + Gets the position of this ParameterContextEntity. + The position of this component in the UI if applicable. + + :return: The position of this ParameterContextEntity. + :rtype: PositionDTO + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this ParameterContextEntity. + The position of this component in the UI if applicable. + + :param position: The position of this ParameterContextEntity. + :type: PositionDTO + """ + + self._position = position + + @property + def permissions(self): + """ + Gets the permissions of this ParameterContextEntity. + The permissions for this component. + + :return: The permissions of this ParameterContextEntity. + :rtype: PermissionsDTO + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ParameterContextEntity. + The permissions for this component. + + :param permissions: The permissions of this ParameterContextEntity. + :type: PermissionsDTO + """ + + self._permissions = permissions + + @property + def bulletins(self): + """ + Gets the bulletins of this ParameterContextEntity. + The bulletins for this component. + + :return: The bulletins of this ParameterContextEntity. + :rtype: list[BulletinEntity] + """ + return self._bulletins + + @bulletins.setter + def bulletins(self, bulletins): + """ + Sets the bulletins of this ParameterContextEntity. + The bulletins for this component. + + :param bulletins: The bulletins of this ParameterContextEntity. + :type: list[BulletinEntity] + """ + + self._bulletins = bulletins + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ParameterContextEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ParameterContextEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ParameterContextEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterContextEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def component(self): + """ + Gets the component of this ParameterContextEntity. + The Parameter Context + + :return: The component of this ParameterContextEntity. + :rtype: ParameterContextDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ParameterContextEntity. + The Parameter Context + + :param component: The component of this ParameterContextEntity. + :type: ParameterContextDTO + """ + + self._component = component + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_reference_dto.py b/nipyapi/nifi/models/parameter_context_reference_dto.py new file mode 100644 index 00000000..8d5a0733 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_reference_dto.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextReferenceDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'name': 'str' + } + + attribute_map = { + 'id': 'id', + 'name': 'name' + } + + def __init__(self, id=None, name=None): + """ + ParameterContextReferenceDTO - a model defined in Swagger + """ + + self._id = None + self._name = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + + @property + def id(self): + """ + Gets the id of this ParameterContextReferenceDTO. + The ID of the Parameter Context + + :return: The id of this ParameterContextReferenceDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextReferenceDTO. + The ID of the Parameter Context + + :param id: The id of this ParameterContextReferenceDTO. + :type: str + """ + + self._id = id + + @property + def name(self): + """ + Gets the name of this ParameterContextReferenceDTO. + The name of the Parameter Context + + :return: The name of this ParameterContextReferenceDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ParameterContextReferenceDTO. + The name of the Parameter Context + + :param name: The name of this ParameterContextReferenceDTO. + :type: str + """ + + self._name = name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextReferenceDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_reference_entity.py b/nipyapi/nifi/models/parameter_context_reference_entity.py new file mode 100644 index 00000000..d8ccf495 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_reference_entity.py @@ -0,0 +1,179 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextReferenceEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'permissions': 'PermissionsDTO', + 'component': 'ParameterContextReferenceDTO' + } + + attribute_map = { + 'id': 'id', + 'permissions': 'permissions', + 'component': 'component' + } + + def __init__(self, id=None, permissions=None, component=None): + """ + ParameterContextReferenceEntity - a model defined in Swagger + """ + + self._id = None + self._permissions = None + self._component = None + + if id is not None: + self.id = id + if permissions is not None: + self.permissions = permissions + if component is not None: + self.component = component + + @property + def id(self): + """ + Gets the id of this ParameterContextReferenceEntity. + The id of the component. + + :return: The id of this ParameterContextReferenceEntity. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ParameterContextReferenceEntity. + The id of the component. + + :param id: The id of this ParameterContextReferenceEntity. + :type: str + """ + + self._id = id + + @property + def permissions(self): + """ + Gets the permissions of this ParameterContextReferenceEntity. + The permissions for this component. + + :return: The permissions of this ParameterContextReferenceEntity. + :rtype: PermissionsDTO + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ParameterContextReferenceEntity. + The permissions for this component. + + :param permissions: The permissions of this ParameterContextReferenceEntity. + :type: PermissionsDTO + """ + + self._permissions = permissions + + @property + def component(self): + """ + Gets the component of this ParameterContextReferenceEntity. + + :return: The component of this ParameterContextReferenceEntity. + :rtype: ParameterContextReferenceDTO + """ + return self._component + + @component.setter + def component(self, component): + """ + Sets the component of this ParameterContextReferenceEntity. + + :param component: The component of this ParameterContextReferenceEntity. + :type: ParameterContextReferenceDTO + """ + + self._component = component + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextReferenceEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_update_request_dto.py b/nipyapi/nifi/models/parameter_context_update_request_dto.py new file mode 100644 index 00000000..d48faac7 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_update_request_dto.py @@ -0,0 +1,405 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextUpdateRequestDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'request_id': 'str', + 'uri': 'str', + 'submission_time': 'datetime', + 'last_updated': 'datetime', + 'complete': 'bool', + 'failure_reason': 'str', + 'percent_completed': 'int', + 'state': 'str', + 'update_steps': 'list[ParameterContextUpdateStepDTO]', + 'parameter_context': 'ParameterContextDTO', + 'referencing_components': 'list[AffectedComponentEntity]' + } + + attribute_map = { + 'request_id': 'requestId', + 'uri': 'uri', + 'submission_time': 'submissionTime', + 'last_updated': 'lastUpdated', + 'complete': 'complete', + 'failure_reason': 'failureReason', + 'percent_completed': 'percentCompleted', + 'state': 'state', + 'update_steps': 'updateSteps', + 'parameter_context': 'parameterContext', + 'referencing_components': 'referencingComponents' + } + + def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, parameter_context=None, referencing_components=None): + """ + ParameterContextUpdateRequestDTO - a model defined in Swagger + """ + + self._request_id = None + self._uri = None + self._submission_time = None + self._last_updated = None + self._complete = None + self._failure_reason = None + self._percent_completed = None + self._state = None + self._update_steps = None + self._parameter_context = None + self._referencing_components = None + + if request_id is not None: + self.request_id = request_id + if uri is not None: + self.uri = uri + if submission_time is not None: + self.submission_time = submission_time + if last_updated is not None: + self.last_updated = last_updated + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + if percent_completed is not None: + self.percent_completed = percent_completed + if state is not None: + self.state = state + if update_steps is not None: + self.update_steps = update_steps + if parameter_context is not None: + self.parameter_context = parameter_context + if referencing_components is not None: + self.referencing_components = referencing_components + + @property + def request_id(self): + """ + Gets the request_id of this ParameterContextUpdateRequestDTO. + The ID of the request + + :return: The request_id of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ParameterContextUpdateRequestDTO. + The ID of the request + + :param request_id: The request_id of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._request_id = request_id + + @property + def uri(self): + """ + Gets the uri of this ParameterContextUpdateRequestDTO. + The URI for the request + + :return: The uri of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ParameterContextUpdateRequestDTO. + The URI for the request + + :param uri: The uri of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._uri = uri + + @property + def submission_time(self): + """ + Gets the submission_time of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this ParameterContextUpdateRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this ParameterContextUpdateRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + + @property + def last_updated(self): + """ + Gets the last_updated of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was last updated + + :return: The last_updated of this ParameterContextUpdateRequestDTO. + :rtype: datetime + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """ + Sets the last_updated of this ParameterContextUpdateRequestDTO. + The timestamp of when the request was last updated + + :param last_updated: The last_updated of this ParameterContextUpdateRequestDTO. + :type: datetime + """ + + self._last_updated = last_updated + + @property + def complete(self): + """ + Gets the complete of this ParameterContextUpdateRequestDTO. + Whether or not the request is completed + + :return: The complete of this ParameterContextUpdateRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextUpdateRequestDTO. + Whether or not the request is completed + + :param complete: The complete of this ParameterContextUpdateRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextUpdateRequestDTO. + The reason for the request failing, or null if the request has not failed + + :return: The failure_reason of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextUpdateRequestDTO. + The reason for the request failing, or null if the request has not failed + + :param failure_reason: The failure_reason of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def percent_completed(self): + """ + Gets the percent_completed of this ParameterContextUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this ParameterContextUpdateRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this ParameterContextUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this ParameterContextUpdateRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def state(self): + """ + Gets the state of this ParameterContextUpdateRequestDTO. + A description of the current state of the request + + :return: The state of this ParameterContextUpdateRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ParameterContextUpdateRequestDTO. + A description of the current state of the request + + :param state: The state of this ParameterContextUpdateRequestDTO. + :type: str + """ + + self._state = state + + @property + def update_steps(self): + """ + Gets the update_steps of this ParameterContextUpdateRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :return: The update_steps of this ParameterContextUpdateRequestDTO. + :rtype: list[ParameterContextUpdateStepDTO] + """ + return self._update_steps + + @update_steps.setter + def update_steps(self, update_steps): + """ + Sets the update_steps of this ParameterContextUpdateRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :param update_steps: The update_steps of this ParameterContextUpdateRequestDTO. + :type: list[ParameterContextUpdateStepDTO] + """ + + self._update_steps = update_steps + + @property + def parameter_context(self): + """ + Gets the parameter_context of this ParameterContextUpdateRequestDTO. + The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. + + :return: The parameter_context of this ParameterContextUpdateRequestDTO. + :rtype: ParameterContextDTO + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ParameterContextUpdateRequestDTO. + The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. + + :param parameter_context: The parameter_context of this ParameterContextUpdateRequestDTO. + :type: ParameterContextDTO + """ + + self._parameter_context = parameter_context + + @property + def referencing_components(self): + """ + Gets the referencing_components of this ParameterContextUpdateRequestDTO. + The components that are referenced by the update. + + :return: The referencing_components of this ParameterContextUpdateRequestDTO. + :rtype: list[AffectedComponentEntity] + """ + return self._referencing_components + + @referencing_components.setter + def referencing_components(self, referencing_components): + """ + Sets the referencing_components of this ParameterContextUpdateRequestDTO. + The components that are referenced by the update. + + :param referencing_components: The referencing_components of this ParameterContextUpdateRequestDTO. + :type: list[AffectedComponentEntity] + """ + + self._referencing_components = referencing_components + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextUpdateRequestDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_update_request_entity.py b/nipyapi/nifi/models/parameter_context_update_request_entity.py new file mode 100644 index 00000000..a980f1ac --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_update_request_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextUpdateRequestEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'parameter_context_revision': 'RevisionDTO', + 'request': 'ParameterContextUpdateRequestDTO' + } + + attribute_map = { + 'parameter_context_revision': 'parameterContextRevision', + 'request': 'request' + } + + def __init__(self, parameter_context_revision=None, request=None): + """ + ParameterContextUpdateRequestEntity - a model defined in Swagger + """ + + self._parameter_context_revision = None + self._request = None + + if parameter_context_revision is not None: + self.parameter_context_revision = parameter_context_revision + if request is not None: + self.request = request + + @property + def parameter_context_revision(self): + """ + Gets the parameter_context_revision of this ParameterContextUpdateRequestEntity. + The Revision of the Parameter Context + + :return: The parameter_context_revision of this ParameterContextUpdateRequestEntity. + :rtype: RevisionDTO + """ + return self._parameter_context_revision + + @parameter_context_revision.setter + def parameter_context_revision(self, parameter_context_revision): + """ + Sets the parameter_context_revision of this ParameterContextUpdateRequestEntity. + The Revision of the Parameter Context + + :param parameter_context_revision: The parameter_context_revision of this ParameterContextUpdateRequestEntity. + :type: RevisionDTO + """ + + self._parameter_context_revision = parameter_context_revision + + @property + def request(self): + """ + Gets the request of this ParameterContextUpdateRequestEntity. + The Update Request + + :return: The request of this ParameterContextUpdateRequestEntity. + :rtype: ParameterContextUpdateRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this ParameterContextUpdateRequestEntity. + The Update Request + + :param request: The request of this ParameterContextUpdateRequestEntity. + :type: ParameterContextUpdateRequestDTO + """ + + self._request = request + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextUpdateRequestEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_update_step_dto.py b/nipyapi/nifi/models/parameter_context_update_step_dto.py new file mode 100644 index 00000000..9ccc5f4a --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_update_step_dto.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextUpdateStepDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', + 'complete': 'bool', + 'failure_reason': 'str' + } + + attribute_map = { + 'description': 'description', + 'complete': 'complete', + 'failure_reason': 'failureReason' + } + + def __init__(self, description=None, complete=None, failure_reason=None): + """ + ParameterContextUpdateStepDTO - a model defined in Swagger + """ + + self._description = None + self._complete = None + self._failure_reason = None + + if description is not None: + self.description = description + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + + @property + def description(self): + """ + Gets the description of this ParameterContextUpdateStepDTO. + Explanation of what happens in this step + + :return: The description of this ParameterContextUpdateStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextUpdateStepDTO. + Explanation of what happens in this step + + :param description: The description of this ParameterContextUpdateStepDTO. + :type: str + """ + + self._description = description + + @property + def complete(self): + """ + Gets the complete of this ParameterContextUpdateStepDTO. + Whether or not this step has completed + + :return: The complete of this ParameterContextUpdateStepDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextUpdateStepDTO. + Whether or not this step has completed + + :param complete: The complete of this ParameterContextUpdateStepDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :return: The failure_reason of this ParameterContextUpdateStepDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextUpdateStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :param failure_reason: The failure_reason of this ParameterContextUpdateStepDTO. + :type: str + """ + + self._failure_reason = failure_reason + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextUpdateStepDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_validation_request_dto.py b/nipyapi/nifi/models/parameter_context_validation_request_dto.py new file mode 100644 index 00000000..18dba560 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_validation_request_dto.py @@ -0,0 +1,405 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextValidationRequestDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'request_id': 'str', + 'uri': 'str', + 'submission_time': 'datetime', + 'last_updated': 'datetime', + 'complete': 'bool', + 'failure_reason': 'str', + 'percent_completed': 'int', + 'state': 'str', + 'update_steps': 'list[ParameterContextValidationStepDTO]', + 'parameter_context': 'ParameterContextDTO', + 'component_validation_results': 'ComponentValidationResultsEntity' + } + + attribute_map = { + 'request_id': 'requestId', + 'uri': 'uri', + 'submission_time': 'submissionTime', + 'last_updated': 'lastUpdated', + 'complete': 'complete', + 'failure_reason': 'failureReason', + 'percent_completed': 'percentCompleted', + 'state': 'state', + 'update_steps': 'updateSteps', + 'parameter_context': 'parameterContext', + 'component_validation_results': 'componentValidationResults' + } + + def __init__(self, request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, parameter_context=None, component_validation_results=None): + """ + ParameterContextValidationRequestDTO - a model defined in Swagger + """ + + self._request_id = None + self._uri = None + self._submission_time = None + self._last_updated = None + self._complete = None + self._failure_reason = None + self._percent_completed = None + self._state = None + self._update_steps = None + self._parameter_context = None + self._component_validation_results = None + + if request_id is not None: + self.request_id = request_id + if uri is not None: + self.uri = uri + if submission_time is not None: + self.submission_time = submission_time + if last_updated is not None: + self.last_updated = last_updated + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + if percent_completed is not None: + self.percent_completed = percent_completed + if state is not None: + self.state = state + if update_steps is not None: + self.update_steps = update_steps + if parameter_context is not None: + self.parameter_context = parameter_context + if component_validation_results is not None: + self.component_validation_results = component_validation_results + + @property + def request_id(self): + """ + Gets the request_id of this ParameterContextValidationRequestDTO. + The ID of the request + + :return: The request_id of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ParameterContextValidationRequestDTO. + The ID of the request + + :param request_id: The request_id of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._request_id = request_id + + @property + def uri(self): + """ + Gets the uri of this ParameterContextValidationRequestDTO. + The URI for the request + + :return: The uri of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ParameterContextValidationRequestDTO. + The URI for the request + + :param uri: The uri of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._uri = uri + + @property + def submission_time(self): + """ + Gets the submission_time of this ParameterContextValidationRequestDTO. + The timestamp of when the request was submitted + + :return: The submission_time of this ParameterContextValidationRequestDTO. + :rtype: datetime + """ + return self._submission_time + + @submission_time.setter + def submission_time(self, submission_time): + """ + Sets the submission_time of this ParameterContextValidationRequestDTO. + The timestamp of when the request was submitted + + :param submission_time: The submission_time of this ParameterContextValidationRequestDTO. + :type: datetime + """ + + self._submission_time = submission_time + + @property + def last_updated(self): + """ + Gets the last_updated of this ParameterContextValidationRequestDTO. + The timestamp of when the request was last updated + + :return: The last_updated of this ParameterContextValidationRequestDTO. + :rtype: datetime + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """ + Sets the last_updated of this ParameterContextValidationRequestDTO. + The timestamp of when the request was last updated + + :param last_updated: The last_updated of this ParameterContextValidationRequestDTO. + :type: datetime + """ + + self._last_updated = last_updated + + @property + def complete(self): + """ + Gets the complete of this ParameterContextValidationRequestDTO. + Whether or not the request is completed + + :return: The complete of this ParameterContextValidationRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextValidationRequestDTO. + Whether or not the request is completed + + :param complete: The complete of this ParameterContextValidationRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextValidationRequestDTO. + The reason for the request failing, or null if the request has not failed + + :return: The failure_reason of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextValidationRequestDTO. + The reason for the request failing, or null if the request has not failed + + :param failure_reason: The failure_reason of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def percent_completed(self): + """ + Gets the percent_completed of this ParameterContextValidationRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this ParameterContextValidationRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this ParameterContextValidationRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this ParameterContextValidationRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def state(self): + """ + Gets the state of this ParameterContextValidationRequestDTO. + A description of the current state of the request + + :return: The state of this ParameterContextValidationRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ParameterContextValidationRequestDTO. + A description of the current state of the request + + :param state: The state of this ParameterContextValidationRequestDTO. + :type: str + """ + + self._state = state + + @property + def update_steps(self): + """ + Gets the update_steps of this ParameterContextValidationRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :return: The update_steps of this ParameterContextValidationRequestDTO. + :rtype: list[ParameterContextValidationStepDTO] + """ + return self._update_steps + + @update_steps.setter + def update_steps(self, update_steps): + """ + Sets the update_steps of this ParameterContextValidationRequestDTO. + The steps that are required in order to complete the request, along with the status of each + + :param update_steps: The update_steps of this ParameterContextValidationRequestDTO. + :type: list[ParameterContextValidationStepDTO] + """ + + self._update_steps = update_steps + + @property + def parameter_context(self): + """ + Gets the parameter_context of this ParameterContextValidationRequestDTO. + The Parameter Context that is being operated on. + + :return: The parameter_context of this ParameterContextValidationRequestDTO. + :rtype: ParameterContextDTO + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ParameterContextValidationRequestDTO. + The Parameter Context that is being operated on. + + :param parameter_context: The parameter_context of this ParameterContextValidationRequestDTO. + :type: ParameterContextDTO + """ + + self._parameter_context = parameter_context + + @property + def component_validation_results(self): + """ + Gets the component_validation_results of this ParameterContextValidationRequestDTO. + The Validation Results that were calculated for each component. This value may not be set until the request completes. + + :return: The component_validation_results of this ParameterContextValidationRequestDTO. + :rtype: ComponentValidationResultsEntity + """ + return self._component_validation_results + + @component_validation_results.setter + def component_validation_results(self, component_validation_results): + """ + Sets the component_validation_results of this ParameterContextValidationRequestDTO. + The Validation Results that were calculated for each component. This value may not be set until the request completes. + + :param component_validation_results: The component_validation_results of this ParameterContextValidationRequestDTO. + :type: ComponentValidationResultsEntity + """ + + self._component_validation_results = component_validation_results + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextValidationRequestDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_validation_request_entity.py b/nipyapi/nifi/models/parameter_context_validation_request_entity.py new file mode 100644 index 00000000..cc35a2fb --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_validation_request_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextValidationRequestEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'request': 'ParameterContextValidationRequestDTO', + 'disconnected_node_acknowledged': 'bool' + } + + attribute_map = { + 'request': 'request', + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' + } + + def __init__(self, request=None, disconnected_node_acknowledged=None): + """ + ParameterContextValidationRequestEntity - a model defined in Swagger + """ + + self._request = None + self._disconnected_node_acknowledged = None + + if request is not None: + self.request = request + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def request(self): + """ + Gets the request of this ParameterContextValidationRequestEntity. + The Update Request + + :return: The request of this ParameterContextValidationRequestEntity. + :rtype: ParameterContextValidationRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this ParameterContextValidationRequestEntity. + The Update Request + + :param request: The request of this ParameterContextValidationRequestEntity. + :type: ParameterContextValidationRequestDTO + """ + + self._request = request + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ParameterContextValidationRequestEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextValidationRequestEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_context_validation_step_dto.py b/nipyapi/nifi/models/parameter_context_validation_step_dto.py new file mode 100644 index 00000000..82bb1b12 --- /dev/null +++ b/nipyapi/nifi/models/parameter_context_validation_step_dto.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextValidationStepDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'description': 'str', + 'complete': 'bool', + 'failure_reason': 'str' + } + + attribute_map = { + 'description': 'description', + 'complete': 'complete', + 'failure_reason': 'failureReason' + } + + def __init__(self, description=None, complete=None, failure_reason=None): + """ + ParameterContextValidationStepDTO - a model defined in Swagger + """ + + self._description = None + self._complete = None + self._failure_reason = None + + if description is not None: + self.description = description + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + + @property + def description(self): + """ + Gets the description of this ParameterContextValidationStepDTO. + Explanation of what happens in this step + + :return: The description of this ParameterContextValidationStepDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterContextValidationStepDTO. + Explanation of what happens in this step + + :param description: The description of this ParameterContextValidationStepDTO. + :type: str + """ + + self._description = description + + @property + def complete(self): + """ + Gets the complete of this ParameterContextValidationStepDTO. + Whether or not this step has completed + + :return: The complete of this ParameterContextValidationStepDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ParameterContextValidationStepDTO. + Whether or not this step has completed + + :param complete: The complete of this ParameterContextValidationStepDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ParameterContextValidationStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :return: The failure_reason of this ParameterContextValidationStepDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ParameterContextValidationStepDTO. + An explanation of why this step failed, or null if this step did not fail + + :param failure_reason: The failure_reason of this ParameterContextValidationStepDTO. + :type: str + """ + + self._failure_reason = failure_reason + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextValidationStepDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_contexts_entity.py b/nipyapi/nifi/models/parameter_contexts_entity.py new file mode 100644 index 00000000..f90bc94c --- /dev/null +++ b/nipyapi/nifi/models/parameter_contexts_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterContextsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'parameter_contexts': 'list[ParameterContextEntity]', + 'current_time': 'str' + } + + attribute_map = { + 'parameter_contexts': 'parameterContexts', + 'current_time': 'currentTime' + } + + def __init__(self, parameter_contexts=None, current_time=None): + """ + ParameterContextsEntity - a model defined in Swagger + """ + + self._parameter_contexts = None + self._current_time = None + + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if current_time is not None: + self.current_time = current_time + + @property + def parameter_contexts(self): + """ + Gets the parameter_contexts of this ParameterContextsEntity. + The Parameter Contexts + + :return: The parameter_contexts of this ParameterContextsEntity. + :rtype: list[ParameterContextEntity] + """ + return self._parameter_contexts + + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): + """ + Sets the parameter_contexts of this ParameterContextsEntity. + The Parameter Contexts + + :param parameter_contexts: The parameter_contexts of this ParameterContextsEntity. + :type: list[ParameterContextEntity] + """ + + self._parameter_contexts = parameter_contexts + + @property + def current_time(self): + """ + Gets the current_time of this ParameterContextsEntity. + The current time on the system. + + :return: The current_time of this ParameterContextsEntity. + :rtype: str + """ + return self._current_time + + @current_time.setter + def current_time(self, current_time): + """ + Sets the current_time of this ParameterContextsEntity. + The current time on the system. + + :param current_time: The current_time of this ParameterContextsEntity. + :type: str + """ + + self._current_time = current_time + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterContextsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_dto.py b/nipyapi/nifi/models/parameter_dto.py new file mode 100644 index 00000000..9ddc80d7 --- /dev/null +++ b/nipyapi/nifi/models/parameter_dto.py @@ -0,0 +1,237 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'sensitive': 'bool', + 'value': 'str', + 'referencing_components': 'list[AffectedComponentEntity]' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'sensitive': 'sensitive', + 'value': 'value', + 'referencing_components': 'referencingComponents' + } + + def __init__(self, name=None, description=None, sensitive=None, value=None, referencing_components=None): + """ + ParameterDTO - a model defined in Swagger + """ + + self._name = None + self._description = None + self._sensitive = None + self._value = None + self._referencing_components = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if sensitive is not None: + self.sensitive = sensitive + if value is not None: + self.value = value + if referencing_components is not None: + self.referencing_components = referencing_components + + @property + def name(self): + """ + Gets the name of this ParameterDTO. + The name of the Parameter + + :return: The name of this ParameterDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ParameterDTO. + The name of the Parameter + + :param name: The name of this ParameterDTO. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this ParameterDTO. + The description of the Parameter + + :return: The description of this ParameterDTO. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this ParameterDTO. + The description of the Parameter + + :param description: The description of this ParameterDTO. + :type: str + """ + + self._description = description + + @property + def sensitive(self): + """ + Gets the sensitive of this ParameterDTO. + Whether or not the Parameter is sensitive + + :return: The sensitive of this ParameterDTO. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this ParameterDTO. + Whether or not the Parameter is sensitive + + :param sensitive: The sensitive of this ParameterDTO. + :type: bool + """ + + self._sensitive = sensitive + + @property + def value(self): + """ + Gets the value of this ParameterDTO. + The value of the Parameter + + :return: The value of this ParameterDTO. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this ParameterDTO. + The value of the Parameter + + :param value: The value of this ParameterDTO. + :type: str + """ + + self._value = value + + @property + def referencing_components(self): + """ + Gets the referencing_components of this ParameterDTO. + The set of all components in the flow that are referencing this Parameter + + :return: The referencing_components of this ParameterDTO. + :rtype: list[AffectedComponentEntity] + """ + return self._referencing_components + + @referencing_components.setter + def referencing_components(self, referencing_components): + """ + Sets the referencing_components of this ParameterDTO. + The set of all components in the flow that are referencing this Parameter + + :param referencing_components: The referencing_components of this ParameterDTO. + :type: list[AffectedComponentEntity] + """ + + self._referencing_components = referencing_components + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/parameter_entity.py b/nipyapi/nifi/models/parameter_entity.py new file mode 100644 index 00000000..ca0bdc72 --- /dev/null +++ b/nipyapi/nifi/models/parameter_entity.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ParameterEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'can_write': 'bool', + 'parameter': 'ParameterDTO' + } + + attribute_map = { + 'can_write': 'canWrite', + 'parameter': 'parameter' + } + + def __init__(self, can_write=None, parameter=None): + """ + ParameterEntity - a model defined in Swagger + """ + + self._can_write = None + self._parameter = None + + if can_write is not None: + self.can_write = can_write + if parameter is not None: + self.parameter = parameter + + @property + def can_write(self): + """ + Gets the can_write of this ParameterEntity. + Indicates whether the user can write a given resource. + + :return: The can_write of this ParameterEntity. + :rtype: bool + """ + return self._can_write + + @can_write.setter + def can_write(self, can_write): + """ + Sets the can_write of this ParameterEntity. + Indicates whether the user can write a given resource. + + :param can_write: The can_write of this ParameterEntity. + :type: bool + """ + + self._can_write = can_write + + @property + def parameter(self): + """ + Gets the parameter of this ParameterEntity. + The parameter information + + :return: The parameter of this ParameterEntity. + :rtype: ParameterDTO + """ + return self._parameter + + @parameter.setter + def parameter(self, parameter): + """ + Sets the parameter of this ParameterEntity. + The parameter information + + :param parameter: The parameter of this ParameterEntity. + :type: ParameterDTO + """ + + self._parameter = parameter + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ParameterEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/peer_dto.py b/nipyapi/nifi/models/peer_dto.py index c9b799e8..4125fc87 100644 --- a/nipyapi/nifi/models/peer_dto.py +++ b/nipyapi/nifi/models/peer_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peers_entity.py b/nipyapi/nifi/models/peers_entity.py index ed086803..b87f6a1f 100644 --- a/nipyapi/nifi/models/peers_entity.py +++ b/nipyapi/nifi/models/peers_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions.py b/nipyapi/nifi/models/permissions.py index 106a82bb..5b078121 100644 --- a/nipyapi/nifi/models/permissions.py +++ b/nipyapi/nifi/models/permissions.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions_dto.py b/nipyapi/nifi/models/permissions_dto.py index a270bf0f..eafa7e9d 100644 --- a/nipyapi/nifi/models/permissions_dto.py +++ b/nipyapi/nifi/models/permissions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_dto.py b/nipyapi/nifi/models/port_dto.py index 3f008910..9f2685a6 100644 --- a/nipyapi/nifi/models/port_dto.py +++ b/nipyapi/nifi/models/port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,6 +43,7 @@ class PortDTO(object): 'concurrently_schedulable_task_count': 'int', 'user_access_control': 'list[str]', 'group_access_control': 'list[str]', + 'allow_remote_access': 'bool', 'validation_errors': 'list[str]' } @@ -59,10 +60,11 @@ class PortDTO(object): 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'user_access_control': 'userAccessControl', 'group_access_control': 'groupAccessControl', + 'allow_remote_access': 'allowRemoteAccess', 'validation_errors': 'validationErrors' } - def __init__(self, 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, validation_errors=None): + def __init__(self, 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): """ PortDTO - a model defined in Swagger """ @@ -79,6 +81,7 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self._concurrently_schedulable_task_count = None self._user_access_control = None self._group_access_control = None + self._allow_remote_access = None self._validation_errors = None if id is not None: @@ -105,6 +108,8 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self.user_access_control = user_access_control if group_access_control is not None: self.group_access_control = group_access_control + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access if validation_errors is not None: self.validation_errors = validation_errors @@ -308,7 +313,7 @@ def type(self, type): def transmitting(self): """ 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 running in the root group. + 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. :return: The transmitting of this PortDTO. :rtype: bool @@ -319,7 +324,7 @@ def transmitting(self): def transmitting(self, transmitting): """ Sets 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 running in the root group. + 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. :param transmitting: The transmitting of this PortDTO. :type: bool @@ -396,6 +401,29 @@ def group_access_control(self, group_access_control): self._group_access_control = group_access_control + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this PortDTO. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :return: The allow_remote_access of this PortDTO. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this PortDTO. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :param allow_remote_access: The allow_remote_access of this PortDTO. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + @property def validation_errors(self): """ diff --git a/nipyapi/nifi/models/port_entity.py b/nipyapi/nifi/models/port_entity.py index 829065a2..af3b8d5b 100644 --- a/nipyapi/nifi/models/port_entity.py +++ b/nipyapi/nifi/models/port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,7 +41,8 @@ class PortEntity(object): 'component': 'PortDTO', 'status': 'PortStatusDTO', 'port_type': 'str', - 'operate_permissions': 'PermissionsDTO' + 'operate_permissions': 'PermissionsDTO', + 'allow_remote_access': 'bool' } attribute_map = { @@ -55,10 +56,11 @@ class PortEntity(object): 'component': 'component', 'status': 'status', 'port_type': 'portType', - 'operate_permissions': 'operatePermissions' + 'operate_permissions': 'operatePermissions', + 'allow_remote_access': 'allowRemoteAccess' } - def __init__(self, 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): + def __init__(self, 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): """ PortEntity - a model defined in Swagger """ @@ -74,6 +76,7 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self._status = None self._port_type = None self._operate_permissions = None + self._allow_remote_access = None if revision is not None: self.revision = revision @@ -97,6 +100,8 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self.port_type = port_type if operate_permissions is not None: self.operate_permissions = operate_permissions + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access @property def revision(self): @@ -347,6 +352,29 @@ def operate_permissions(self, operate_permissions): self._operate_permissions = operate_permissions + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this PortEntity. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :return: The allow_remote_access of this PortEntity. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this PortEntity. + Whether this port can be accessed remotely via Site-to-Site protocol. + + :param allow_remote_access: The allow_remote_access of this PortEntity. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/port_run_status_entity.py b/nipyapi/nifi/models/port_run_status_entity.py index 5dc0503e..efdc6040 100644 --- a/nipyapi/nifi/models/port_run_status_entity.py +++ b/nipyapi/nifi/models/port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_dto.py b/nipyapi/nifi/models/port_status_dto.py index 465c7bec..92a0d5e0 100644 --- a/nipyapi/nifi/models/port_status_dto.py +++ b/nipyapi/nifi/models/port_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_entity.py b/nipyapi/nifi/models/port_status_entity.py index c28397df..adc7c9f2 100644 --- a/nipyapi/nifi/models/port_status_entity.py +++ b/nipyapi/nifi/models/port_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_dto.py b/nipyapi/nifi/models/port_status_snapshot_dto.py index 0486da38..f9e9aea5 100644 --- a/nipyapi/nifi/models/port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_entity.py b/nipyapi/nifi/models/port_status_snapshot_entity.py index d502ee9f..c021e925 100644 --- a/nipyapi/nifi/models/port_status_snapshot_entity.py +++ b/nipyapi/nifi/models/port_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position.py b/nipyapi/nifi/models/position.py index 84a30516..c6ae7b92 100644 --- a/nipyapi/nifi/models/position.py +++ b/nipyapi/nifi/models/position.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position_dto.py b/nipyapi/nifi/models/position_dto.py index 0f9d6d34..b7a1ffb1 100644 --- a/nipyapi/nifi/models/position_dto.py +++ b/nipyapi/nifi/models/position_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/previous_value_dto.py b/nipyapi/nifi/models/previous_value_dto.py index 2d7df501..ae46d106 100644 --- a/nipyapi/nifi/models/previous_value_dto.py +++ b/nipyapi/nifi/models/previous_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/prioritizer_types_entity.py b/nipyapi/nifi/models/prioritizer_types_entity.py index 77d044a8..9ddbea7b 100644 --- a/nipyapi/nifi/models/prioritizer_types_entity.py +++ b/nipyapi/nifi/models/prioritizer_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_dto.py b/nipyapi/nifi/models/process_group_dto.py index 3f45c07b..58745f54 100644 --- a/nipyapi/nifi/models/process_group_dto.py +++ b/nipyapi/nifi/models/process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -39,6 +39,7 @@ class ProcessGroupDTO(object): 'comments': 'str', 'variables': 'dict(str, str)', 'version_control_information': 'VersionControlInformationDTO', + 'parameter_context': 'ParameterContextReferenceEntity', 'running_count': 'int', 'stopped_count': 'int', 'invalid_count': 'int', @@ -50,9 +51,13 @@ class ProcessGroupDTO(object): 'stale_count': 'int', 'locally_modified_and_stale_count': 'int', 'sync_failure_count': 'int', + 'local_input_port_count': 'int', + 'local_output_port_count': 'int', + 'public_input_port_count': 'int', + 'public_output_port_count': 'int', + 'contents': 'FlowSnippetDTO', 'input_port_count': 'int', - 'output_port_count': 'int', - 'contents': 'FlowSnippetDTO' + 'output_port_count': 'int' } attribute_map = { @@ -64,6 +69,7 @@ class ProcessGroupDTO(object): 'comments': 'comments', 'variables': 'variables', 'version_control_information': 'versionControlInformation', + 'parameter_context': 'parameterContext', 'running_count': 'runningCount', 'stopped_count': 'stoppedCount', 'invalid_count': 'invalidCount', @@ -75,12 +81,16 @@ class ProcessGroupDTO(object): 'stale_count': 'staleCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'sync_failure_count': 'syncFailureCount', + 'local_input_port_count': 'localInputPortCount', + 'local_output_port_count': 'localOutputPortCount', + 'public_input_port_count': 'publicInputPortCount', + 'public_output_port_count': 'publicOutputPortCount', + 'contents': 'contents', 'input_port_count': 'inputPortCount', - 'output_port_count': 'outputPortCount', - 'contents': 'contents' + 'output_port_count': 'outputPortCount' } - def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, variables=None, version_control_information=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, input_port_count=None, output_port_count=None, contents=None): + def __init__(self, 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, 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): """ ProcessGroupDTO - a model defined in Swagger """ @@ -93,6 +103,7 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self._comments = None self._variables = None self._version_control_information = None + self._parameter_context = None self._running_count = None self._stopped_count = None self._invalid_count = None @@ -104,9 +115,13 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self._stale_count = None self._locally_modified_and_stale_count = None self._sync_failure_count = None + self._local_input_port_count = None + self._local_output_port_count = None + self._public_input_port_count = None + self._public_output_port_count = None + self._contents = None self._input_port_count = None self._output_port_count = None - self._contents = None if id is not None: self.id = id @@ -124,6 +139,8 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self.variables = variables if version_control_information is not None: self.version_control_information = version_control_information + if parameter_context is not None: + self.parameter_context = parameter_context if running_count is not None: self.running_count = running_count if stopped_count is not None: @@ -146,12 +163,20 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self.locally_modified_and_stale_count = locally_modified_and_stale_count if sync_failure_count is not None: self.sync_failure_count = sync_failure_count + if local_input_port_count is not None: + self.local_input_port_count = local_input_port_count + if local_output_port_count is not None: + self.local_output_port_count = local_output_port_count + if public_input_port_count is not None: + self.public_input_port_count = public_input_port_count + if public_output_port_count is not None: + self.public_output_port_count = public_output_port_count + if contents is not None: + self.contents = contents if input_port_count is not None: self.input_port_count = input_port_count if output_port_count is not None: self.output_port_count = output_port_count - if contents is not None: - self.contents = contents @property def id(self): @@ -337,6 +362,29 @@ def version_control_information(self, version_control_information): self._version_control_information = version_control_information + @property + def parameter_context(self): + """ + Gets the parameter_context of this ProcessGroupDTO. + The Parameter Context that this Process Group is bound to. + + :return: The parameter_context of this ProcessGroupDTO. + :rtype: ParameterContextReferenceEntity + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ProcessGroupDTO. + The Parameter Context that this Process Group is bound to. + + :param parameter_context: The parameter_context of this ProcessGroupDTO. + :type: ParameterContextReferenceEntity + """ + + self._parameter_context = parameter_context + @property def running_count(self): """ @@ -591,50 +639,96 @@ def sync_failure_count(self, sync_failure_count): self._sync_failure_count = sync_failure_count @property - def input_port_count(self): + def local_input_port_count(self): """ - Gets the input_port_count of this ProcessGroupDTO. - The number of input ports in the process group. + Gets the local_input_port_count of this ProcessGroupDTO. + The number of local input ports in the process group. - :return: The input_port_count of this ProcessGroupDTO. + :return: The local_input_port_count of this ProcessGroupDTO. :rtype: int """ - return self._input_port_count + return self._local_input_port_count - @input_port_count.setter - def input_port_count(self, input_port_count): + @local_input_port_count.setter + def local_input_port_count(self, local_input_port_count): """ - Sets the input_port_count of this ProcessGroupDTO. - The number of input ports in the process group. + Sets the local_input_port_count of this ProcessGroupDTO. + The number of local input ports in the process group. - :param input_port_count: The input_port_count of this ProcessGroupDTO. + :param local_input_port_count: The local_input_port_count of this ProcessGroupDTO. :type: int """ - self._input_port_count = input_port_count + self._local_input_port_count = local_input_port_count @property - def output_port_count(self): + def local_output_port_count(self): """ - Gets the output_port_count of this ProcessGroupDTO. - The number of output ports in the process group. + Gets the local_output_port_count of this ProcessGroupDTO. + The number of local output ports in the process group. - :return: The output_port_count of this ProcessGroupDTO. + :return: The local_output_port_count of this ProcessGroupDTO. :rtype: int """ - return self._output_port_count + return self._local_output_port_count - @output_port_count.setter - def output_port_count(self, output_port_count): + @local_output_port_count.setter + def local_output_port_count(self, local_output_port_count): """ - Sets the output_port_count of this ProcessGroupDTO. - The number of output ports in the process group. + Sets the local_output_port_count of this ProcessGroupDTO. + The number of local output ports in the process group. - :param output_port_count: The output_port_count of this ProcessGroupDTO. + :param local_output_port_count: The local_output_port_count of this ProcessGroupDTO. :type: int """ - self._output_port_count = output_port_count + self._local_output_port_count = local_output_port_count + + @property + def public_input_port_count(self): + """ + Gets the public_input_port_count of this ProcessGroupDTO. + The number of public input ports in the process group. + + :return: The public_input_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._public_input_port_count + + @public_input_port_count.setter + def public_input_port_count(self, public_input_port_count): + """ + Sets the public_input_port_count of this ProcessGroupDTO. + The number of public input ports in the process group. + + :param public_input_port_count: The public_input_port_count of this ProcessGroupDTO. + :type: int + """ + + self._public_input_port_count = public_input_port_count + + @property + def public_output_port_count(self): + """ + Gets the public_output_port_count of this ProcessGroupDTO. + The number of public output ports in the process group. + + :return: The public_output_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._public_output_port_count + + @public_output_port_count.setter + def public_output_port_count(self, public_output_port_count): + """ + Sets the public_output_port_count of this ProcessGroupDTO. + The number of public output ports in the process group. + + :param public_output_port_count: The public_output_port_count of this ProcessGroupDTO. + :type: int + """ + + self._public_output_port_count = public_output_port_count @property def contents(self): @@ -659,6 +753,52 @@ def contents(self, contents): self._contents = contents + @property + def input_port_count(self): + """ + Gets the input_port_count of this ProcessGroupDTO. + The number of input ports in the process group. + + :return: The input_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._input_port_count + + @input_port_count.setter + def input_port_count(self, input_port_count): + """ + Sets the input_port_count of this ProcessGroupDTO. + The number of input ports in the process group. + + :param input_port_count: The input_port_count of this ProcessGroupDTO. + :type: int + """ + + self._input_port_count = input_port_count + + @property + def output_port_count(self): + """ + Gets the output_port_count of this ProcessGroupDTO. + The number of output ports in the process group. + + :return: The output_port_count of this ProcessGroupDTO. + :rtype: int + """ + return self._output_port_count + + @output_port_count.setter + def output_port_count(self, output_port_count): + """ + Sets the output_port_count of this ProcessGroupDTO. + The number of output ports in the process group. + + :param output_port_count: The output_port_count of this ProcessGroupDTO. + :type: int + """ + + self._output_port_count = output_port_count + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/process_group_entity.py b/nipyapi/nifi/models/process_group_entity.py index 1ca196e0..7de62677 100644 --- a/nipyapi/nifi/models/process_group_entity.py +++ b/nipyapi/nifi/models/process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -53,6 +53,11 @@ class ProcessGroupEntity(object): 'stale_count': 'int', 'locally_modified_and_stale_count': 'int', 'sync_failure_count': 'int', + 'local_input_port_count': 'int', + 'local_output_port_count': 'int', + 'public_input_port_count': 'int', + 'public_output_port_count': 'int', + 'parameter_context': 'ParameterContextReferenceEntity', 'input_port_count': 'int', 'output_port_count': 'int' } @@ -80,11 +85,16 @@ class ProcessGroupEntity(object): 'stale_count': 'staleCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'sync_failure_count': 'syncFailureCount', + 'local_input_port_count': 'localInputPortCount', + 'local_output_port_count': 'localOutputPortCount', + 'public_input_port_count': 'publicInputPortCount', + 'public_output_port_count': 'publicOutputPortCount', + 'parameter_context': 'parameterContext', 'input_port_count': 'inputPortCount', 'output_port_count': 'outputPortCount' } - def __init__(self, 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, input_port_count=None, output_port_count=None): + def __init__(self, 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): """ ProcessGroupEntity - a model defined in Swagger """ @@ -111,6 +121,11 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self._stale_count = None self._locally_modified_and_stale_count = None self._sync_failure_count = None + self._local_input_port_count = None + self._local_output_port_count = None + self._public_input_port_count = None + self._public_output_port_count = None + self._parameter_context = None self._input_port_count = None self._output_port_count = None @@ -158,6 +173,16 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self.locally_modified_and_stale_count = locally_modified_and_stale_count if sync_failure_count is not None: self.sync_failure_count = sync_failure_count + if local_input_port_count is not None: + self.local_input_port_count = local_input_port_count + if local_output_port_count is not None: + self.local_output_port_count = local_output_port_count + if public_input_port_count is not None: + self.public_input_port_count = public_input_port_count + if public_output_port_count is not None: + self.public_output_port_count = public_output_port_count + if parameter_context is not None: + self.parameter_context = parameter_context if input_port_count is not None: self.input_port_count = input_port_count if output_port_count is not None: @@ -673,6 +698,121 @@ def sync_failure_count(self, sync_failure_count): self._sync_failure_count = sync_failure_count + @property + def local_input_port_count(self): + """ + Gets the local_input_port_count of this ProcessGroupEntity. + The number of local input ports in the process group. + + :return: The local_input_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._local_input_port_count + + @local_input_port_count.setter + def local_input_port_count(self, local_input_port_count): + """ + Sets the local_input_port_count of this ProcessGroupEntity. + The number of local input ports in the process group. + + :param local_input_port_count: The local_input_port_count of this ProcessGroupEntity. + :type: int + """ + + self._local_input_port_count = local_input_port_count + + @property + def local_output_port_count(self): + """ + Gets the local_output_port_count of this ProcessGroupEntity. + The number of local output ports in the process group. + + :return: The local_output_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._local_output_port_count + + @local_output_port_count.setter + def local_output_port_count(self, local_output_port_count): + """ + Sets the local_output_port_count of this ProcessGroupEntity. + The number of local output ports in the process group. + + :param local_output_port_count: The local_output_port_count of this ProcessGroupEntity. + :type: int + """ + + self._local_output_port_count = local_output_port_count + + @property + def public_input_port_count(self): + """ + Gets the public_input_port_count of this ProcessGroupEntity. + The number of public input ports in the process group. + + :return: The public_input_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._public_input_port_count + + @public_input_port_count.setter + def public_input_port_count(self, public_input_port_count): + """ + Sets the public_input_port_count of this ProcessGroupEntity. + The number of public input ports in the process group. + + :param public_input_port_count: The public_input_port_count of this ProcessGroupEntity. + :type: int + """ + + self._public_input_port_count = public_input_port_count + + @property + def public_output_port_count(self): + """ + Gets the public_output_port_count of this ProcessGroupEntity. + The number of public output ports in the process group. + + :return: The public_output_port_count of this ProcessGroupEntity. + :rtype: int + """ + return self._public_output_port_count + + @public_output_port_count.setter + def public_output_port_count(self, public_output_port_count): + """ + Sets the public_output_port_count of this ProcessGroupEntity. + The number of public output ports in the process group. + + :param public_output_port_count: The public_output_port_count of this ProcessGroupEntity. + :type: int + """ + + self._public_output_port_count = public_output_port_count + + @property + def parameter_context(self): + """ + Gets the parameter_context of this ProcessGroupEntity. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :return: The parameter_context of this ProcessGroupEntity. + :rtype: ParameterContextReferenceEntity + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ProcessGroupEntity. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :param parameter_context: The parameter_context of this ProcessGroupEntity. + :type: ParameterContextReferenceEntity + """ + + self._parameter_context = parameter_context + @property def input_port_count(self): """ diff --git a/nipyapi/nifi/models/process_group_flow_dto.py b/nipyapi/nifi/models/process_group_flow_dto.py index f38e46a9..d99ae92a 100644 --- a/nipyapi/nifi/models/process_group_flow_dto.py +++ b/nipyapi/nifi/models/process_group_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -34,6 +34,7 @@ class ProcessGroupFlowDTO(object): 'id': 'str', 'uri': 'str', 'parent_group_id': 'str', + 'parameter_context': 'ParameterContextReferenceEntity', 'breadcrumb': 'FlowBreadcrumbEntity', 'flow': 'FlowDTO', 'last_refreshed': 'str' @@ -43,12 +44,13 @@ class ProcessGroupFlowDTO(object): 'id': 'id', 'uri': 'uri', 'parent_group_id': 'parentGroupId', + 'parameter_context': 'parameterContext', 'breadcrumb': 'breadcrumb', 'flow': 'flow', 'last_refreshed': 'lastRefreshed' } - def __init__(self, id=None, uri=None, parent_group_id=None, breadcrumb=None, flow=None, last_refreshed=None): + def __init__(self, id=None, uri=None, parent_group_id=None, parameter_context=None, breadcrumb=None, flow=None, last_refreshed=None): """ ProcessGroupFlowDTO - a model defined in Swagger """ @@ -56,6 +58,7 @@ def __init__(self, id=None, uri=None, parent_group_id=None, breadcrumb=None, flo self._id = None self._uri = None self._parent_group_id = None + self._parameter_context = None self._breadcrumb = None self._flow = None self._last_refreshed = None @@ -66,6 +69,8 @@ def __init__(self, id=None, uri=None, parent_group_id=None, breadcrumb=None, flo self.uri = uri if parent_group_id is not None: self.parent_group_id = parent_group_id + if parameter_context is not None: + self.parameter_context = parameter_context if breadcrumb is not None: self.breadcrumb = breadcrumb if flow is not None: @@ -142,6 +147,29 @@ def parent_group_id(self, parent_group_id): self._parent_group_id = parent_group_id + @property + def parameter_context(self): + """ + Gets the parameter_context of this ProcessGroupFlowDTO. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :return: The parameter_context of this ProcessGroupFlowDTO. + :rtype: ParameterContextReferenceEntity + """ + return self._parameter_context + + @parameter_context.setter + def parameter_context(self, parameter_context): + """ + Sets the parameter_context of this ProcessGroupFlowDTO. + The Parameter Context, or null if no Parameter Context has been bound to the Process Group + + :param parameter_context: The parameter_context of this ProcessGroupFlowDTO. + :type: ParameterContextReferenceEntity + """ + + self._parameter_context = parameter_context + @property def breadcrumb(self): """ diff --git a/nipyapi/nifi/models/process_group_flow_entity.py b/nipyapi/nifi/models/process_group_flow_entity.py index 242ef005..20c8be40 100644 --- a/nipyapi/nifi/models/process_group_flow_entity.py +++ b/nipyapi/nifi/models/process_group_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_name_dto.py b/nipyapi/nifi/models/process_group_name_dto.py new file mode 100644 index 00000000..769f3757 --- /dev/null +++ b/nipyapi/nifi/models/process_group_name_dto.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessGroupNameDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'name': 'str' + } + + attribute_map = { + 'id': 'id', + 'name': 'name' + } + + def __init__(self, id=None, name=None): + """ + ProcessGroupNameDTO - a model defined in Swagger + """ + + self._id = None + self._name = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + + @property + def id(self): + """ + Gets the id of this ProcessGroupNameDTO. + The ID of the Process Group + + :return: The id of this ProcessGroupNameDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ProcessGroupNameDTO. + The ID of the Process Group + + :param id: The id of this ProcessGroupNameDTO. + :type: str + """ + + self._id = id + + @property + def name(self): + """ + Gets the name of this ProcessGroupNameDTO. + The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group + + :return: The name of this ProcessGroupNameDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ProcessGroupNameDTO. + The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group + + :param name: The name of this ProcessGroupNameDTO. + :type: str + """ + + self._name = name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessGroupNameDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/process_group_status_dto.py b/nipyapi/nifi/models/process_group_status_dto.py index 99030b88..df51175a 100644 --- a/nipyapi/nifi/models/process_group_status_dto.py +++ b/nipyapi/nifi/models/process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_entity.py b/nipyapi/nifi/models/process_group_status_entity.py index ea6e0fde..f46e4de3 100644 --- a/nipyapi/nifi/models/process_group_status_entity.py +++ b/nipyapi/nifi/models/process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_dto.py b/nipyapi/nifi/models/process_group_status_snapshot_dto.py index 7b2426a1..844e6e2e 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_entity.py b/nipyapi/nifi/models/process_group_status_snapshot_entity.py index 56343962..06099445 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_groups_entity.py b/nipyapi/nifi/models/process_groups_entity.py index 40ed2b64..f542f916 100644 --- a/nipyapi/nifi/models/process_groups_entity.py +++ b/nipyapi/nifi/models/process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_config_dto.py b/nipyapi/nifi/models/processor_config_dto.py index 751525ec..aac75c74 100644 --- a/nipyapi/nifi/models/processor_config_dto.py +++ b/nipyapi/nifi/models/processor_config_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_dto.py b/nipyapi/nifi/models/processor_dto.py index 66f41b2f..22288d8a 100644 --- a/nipyapi/nifi/models/processor_dto.py +++ b/nipyapi/nifi/models/processor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_entity.py b/nipyapi/nifi/models/processor_entity.py index 63f006f6..5abf2de7 100644 --- a/nipyapi/nifi/models/processor_entity.py +++ b/nipyapi/nifi/models/processor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_run_status_entity.py b/nipyapi/nifi/models/processor_run_status_entity.py index 3ecdb580..d9d5f0e1 100644 --- a/nipyapi/nifi/models/processor_run_status_entity.py +++ b/nipyapi/nifi/models/processor_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_dto.py b/nipyapi/nifi/models/processor_status_dto.py index aecbf667..19b8049d 100644 --- a/nipyapi/nifi/models/processor_status_dto.py +++ b/nipyapi/nifi/models/processor_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_entity.py b/nipyapi/nifi/models/processor_status_entity.py index 9275597e..9a38953f 100644 --- a/nipyapi/nifi/models/processor_status_entity.py +++ b/nipyapi/nifi/models/processor_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_dto.py b/nipyapi/nifi/models/processor_status_snapshot_dto.py index c472297e..5488e91e 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_entity.py b/nipyapi/nifi/models/processor_status_snapshot_entity.py index a1aabe47..fe7c0ce4 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_entity.py +++ b/nipyapi/nifi/models/processor_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_types_entity.py b/nipyapi/nifi/models/processor_types_entity.py index b888333a..2a29682f 100644 --- a/nipyapi/nifi/models/processor_types_entity.py +++ b/nipyapi/nifi/models/processor_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processors_entity.py b/nipyapi/nifi/models/processors_entity.py index 2ce65c23..1f38a11a 100644 --- a/nipyapi/nifi/models/processors_entity.py +++ b/nipyapi/nifi/models/processors_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_dto.py b/nipyapi/nifi/models/property_descriptor_dto.py index b421ba7b..75c7a2a0 100644 --- a/nipyapi/nifi/models/property_descriptor_dto.py +++ b/nipyapi/nifi/models/property_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_entity.py b/nipyapi/nifi/models/property_descriptor_entity.py index 00b1d9b5..8feb21ba 100644 --- a/nipyapi/nifi/models/property_descriptor_entity.py +++ b/nipyapi/nifi/models/property_descriptor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_history_dto.py b/nipyapi/nifi/models/property_history_dto.py index efe9553d..452bc4aa 100644 --- a/nipyapi/nifi/models/property_history_dto.py +++ b/nipyapi/nifi/models/property_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_dto.py b/nipyapi/nifi/models/provenance_dto.py index 758d824f..d2b54322 100644 --- a/nipyapi/nifi/models/provenance_dto.py +++ b/nipyapi/nifi/models/provenance_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_entity.py b/nipyapi/nifi/models/provenance_entity.py index e8adbce0..3452a681 100644 --- a/nipyapi/nifi/models/provenance_entity.py +++ b/nipyapi/nifi/models/provenance_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_dto.py b/nipyapi/nifi/models/provenance_event_dto.py index d588ed0a..11f7c112 100644 --- a/nipyapi/nifi/models/provenance_event_dto.py +++ b/nipyapi/nifi/models/provenance_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_entity.py b/nipyapi/nifi/models/provenance_event_entity.py index 8f66312b..5f077a8f 100644 --- a/nipyapi/nifi/models/provenance_event_entity.py +++ b/nipyapi/nifi/models/provenance_event_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_link_dto.py b/nipyapi/nifi/models/provenance_link_dto.py index 95b80b5f..1d6e1b1d 100644 --- a/nipyapi/nifi/models/provenance_link_dto.py +++ b/nipyapi/nifi/models/provenance_link_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_node_dto.py b/nipyapi/nifi/models/provenance_node_dto.py index c5b8263a..c10f1690 100644 --- a/nipyapi/nifi/models/provenance_node_dto.py +++ b/nipyapi/nifi/models/provenance_node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_dto.py b/nipyapi/nifi/models/provenance_options_dto.py index f106c308..61960d32 100644 --- a/nipyapi/nifi/models/provenance_options_dto.py +++ b/nipyapi/nifi/models/provenance_options_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_entity.py b/nipyapi/nifi/models/provenance_options_entity.py index 92b0db44..11515a72 100644 --- a/nipyapi/nifi/models/provenance_options_entity.py +++ b/nipyapi/nifi/models/provenance_options_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_request_dto.py b/nipyapi/nifi/models/provenance_request_dto.py index 7c845915..7c89f8f4 100644 --- a/nipyapi/nifi/models/provenance_request_dto.py +++ b/nipyapi/nifi/models/provenance_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_results_dto.py b/nipyapi/nifi/models/provenance_results_dto.py index e00a43c3..4c149b9c 100644 --- a/nipyapi/nifi/models/provenance_results_dto.py +++ b/nipyapi/nifi/models/provenance_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_searchable_field_dto.py b/nipyapi/nifi/models/provenance_searchable_field_dto.py index 4e551026..bf004b3c 100644 --- a/nipyapi/nifi/models/provenance_searchable_field_dto.py +++ b/nipyapi/nifi/models/provenance_searchable_field_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/queue_size_dto.py b/nipyapi/nifi/models/queue_size_dto.py index d94614cf..22e28a13 100644 --- a/nipyapi/nifi/models/queue_size_dto.py +++ b/nipyapi/nifi/models/queue_size_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_client_entity.py b/nipyapi/nifi/models/registry_client_entity.py index 854cd991..7988a9ef 100644 --- a/nipyapi/nifi/models/registry_client_entity.py +++ b/nipyapi/nifi/models/registry_client_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_clients_entity.py b/nipyapi/nifi/models/registry_clients_entity.py index 63ddbcb9..b2172920 100644 --- a/nipyapi/nifi/models/registry_clients_entity.py +++ b/nipyapi/nifi/models/registry_clients_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_dto.py b/nipyapi/nifi/models/registry_dto.py index 578c4acc..860a8856 100644 --- a/nipyapi/nifi/models/registry_dto.py +++ b/nipyapi/nifi/models/registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/relationship_dto.py b/nipyapi/nifi/models/relationship_dto.py index 540b5709..be415f73 100644 --- a/nipyapi/nifi/models/relationship_dto.py +++ b/nipyapi/nifi/models/relationship_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_port_run_status_entity.py b/nipyapi/nifi/models/remote_port_run_status_entity.py index 663f5c55..846ae1ce 100644 --- a/nipyapi/nifi/models/remote_port_run_status_entity.py +++ b/nipyapi/nifi/models/remote_port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_contents_dto.py b/nipyapi/nifi/models/remote_process_group_contents_dto.py index 451f2caf..cab77a69 100644 --- a/nipyapi/nifi/models/remote_process_group_contents_dto.py +++ b/nipyapi/nifi/models/remote_process_group_contents_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_dto.py b/nipyapi/nifi/models/remote_process_group_dto.py index 087d3a68..bf48de30 100644 --- a/nipyapi/nifi/models/remote_process_group_dto.py +++ b/nipyapi/nifi/models/remote_process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_entity.py b/nipyapi/nifi/models/remote_process_group_entity.py index 89327053..b4051cd5 100644 --- a/nipyapi/nifi/models/remote_process_group_entity.py +++ b/nipyapi/nifi/models/remote_process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_dto.py b/nipyapi/nifi/models/remote_process_group_port_dto.py index 43417832..f7c44aa0 100644 --- a/nipyapi/nifi/models/remote_process_group_port_dto.py +++ b/nipyapi/nifi/models/remote_process_group_port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_entity.py b/nipyapi/nifi/models/remote_process_group_port_entity.py index 35a1187a..f8e0bb2a 100644 --- a/nipyapi/nifi/models/remote_process_group_port_entity.py +++ b/nipyapi/nifi/models/remote_process_group_port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_dto.py b/nipyapi/nifi/models/remote_process_group_status_dto.py index f1cb019e..c44e041c 100644 --- a/nipyapi/nifi/models/remote_process_group_status_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_entity.py b/nipyapi/nifi/models/remote_process_group_status_entity.py index 711cb199..5052574f 100644 --- a/nipyapi/nifi/models/remote_process_group_status_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py index 3cc97e54..28a75c28 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py index 41462df8..f69636eb 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_groups_entity.py b/nipyapi/nifi/models/remote_process_groups_entity.py index 66cbe3c7..cecd9aba 100644 --- a/nipyapi/nifi/models/remote_process_groups_entity.py +++ b/nipyapi/nifi/models/remote_process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_dto.py b/nipyapi/nifi/models/reporting_task_dto.py index 5b19ac00..d5a8a7a2 100644 --- a/nipyapi/nifi/models/reporting_task_dto.py +++ b/nipyapi/nifi/models/reporting_task_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_entity.py b/nipyapi/nifi/models/reporting_task_entity.py index f5497e47..78bb3e20 100644 --- a/nipyapi/nifi/models/reporting_task_entity.py +++ b/nipyapi/nifi/models/reporting_task_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_run_status_entity.py b/nipyapi/nifi/models/reporting_task_run_status_entity.py index 83ffbe88..82d4b7a5 100644 --- a/nipyapi/nifi/models/reporting_task_run_status_entity.py +++ b/nipyapi/nifi/models/reporting_task_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_status_dto.py b/nipyapi/nifi/models/reporting_task_status_dto.py index 664d182e..f65964c5 100644 --- a/nipyapi/nifi/models/reporting_task_status_dto.py +++ b/nipyapi/nifi/models/reporting_task_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_types_entity.py b/nipyapi/nifi/models/reporting_task_types_entity.py index 0e8d295e..58f71da0 100644 --- a/nipyapi/nifi/models/reporting_task_types_entity.py +++ b/nipyapi/nifi/models/reporting_task_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_tasks_entity.py b/nipyapi/nifi/models/reporting_tasks_entity.py index af2692a2..bc39d9a6 100644 --- a/nipyapi/nifi/models/reporting_tasks_entity.py +++ b/nipyapi/nifi/models/reporting_tasks_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/required_permission_dto.py b/nipyapi/nifi/models/required_permission_dto.py index 0597830a..55ce5a03 100644 --- a/nipyapi/nifi/models/required_permission_dto.py +++ b/nipyapi/nifi/models/required_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resource_dto.py b/nipyapi/nifi/models/resource_dto.py index 8e84c99f..9a37354d 100644 --- a/nipyapi/nifi/models/resource_dto.py +++ b/nipyapi/nifi/models/resource_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resources_entity.py b/nipyapi/nifi/models/resources_entity.py index 9af4dc8d..cf0444cd 100644 --- a/nipyapi/nifi/models/resources_entity.py +++ b/nipyapi/nifi/models/resources_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/revision_dto.py b/nipyapi/nifi/models/revision_dto.py index 6306eca9..584d4baa 100644 --- a/nipyapi/nifi/models/revision_dto.py +++ b/nipyapi/nifi/models/revision_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/schedule_components_entity.py b/nipyapi/nifi/models/schedule_components_entity.py index 51bcd6b0..2c19bec1 100644 --- a/nipyapi/nifi/models/schedule_components_entity.py +++ b/nipyapi/nifi/models/schedule_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_result_group_dto.py b/nipyapi/nifi/models/search_result_group_dto.py index 54582f82..0fd323cb 100644 --- a/nipyapi/nifi/models/search_result_group_dto.py +++ b/nipyapi/nifi/models/search_result_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_results_dto.py b/nipyapi/nifi/models/search_results_dto.py index 214761ab..088fc9b9 100644 --- a/nipyapi/nifi/models/search_results_dto.py +++ b/nipyapi/nifi/models/search_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -37,7 +37,9 @@ class SearchResultsDTO(object): 'input_port_results': 'list[ComponentSearchResultDTO]', 'output_port_results': 'list[ComponentSearchResultDTO]', 'remote_process_group_results': 'list[ComponentSearchResultDTO]', - 'funnel_results': 'list[ComponentSearchResultDTO]' + 'funnel_results': 'list[ComponentSearchResultDTO]', + 'parameter_context_results': 'list[ComponentSearchResultDTO]', + 'parameter_results': 'list[ComponentSearchResultDTO]' } attribute_map = { @@ -47,10 +49,12 @@ class SearchResultsDTO(object): 'input_port_results': 'inputPortResults', 'output_port_results': 'outputPortResults', 'remote_process_group_results': 'remoteProcessGroupResults', - 'funnel_results': 'funnelResults' + 'funnel_results': 'funnelResults', + 'parameter_context_results': 'parameterContextResults', + 'parameter_results': 'parameterResults' } - def __init__(self, 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): + def __init__(self, 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, parameter_context_results=None, parameter_results=None): """ SearchResultsDTO - a model defined in Swagger """ @@ -62,6 +66,8 @@ def __init__(self, processor_results=None, connection_results=None, process_grou self._output_port_results = None self._remote_process_group_results = None self._funnel_results = None + self._parameter_context_results = None + self._parameter_results = None if processor_results is not None: self.processor_results = processor_results @@ -77,6 +83,10 @@ def __init__(self, processor_results=None, connection_results=None, process_grou self.remote_process_group_results = remote_process_group_results if funnel_results is not None: self.funnel_results = funnel_results + if parameter_context_results is not None: + self.parameter_context_results = parameter_context_results + if parameter_results is not None: + self.parameter_results = parameter_results @property def processor_results(self): @@ -239,6 +249,52 @@ def funnel_results(self, funnel_results): self._funnel_results = funnel_results + @property + def parameter_context_results(self): + """ + Gets the parameter_context_results of this SearchResultsDTO. + The parameter contexts that matched the search. + + :return: The parameter_context_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._parameter_context_results + + @parameter_context_results.setter + def parameter_context_results(self, parameter_context_results): + """ + Sets the parameter_context_results of this SearchResultsDTO. + The parameter contexts that matched the search. + + :param parameter_context_results: The parameter_context_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._parameter_context_results = parameter_context_results + + @property + def parameter_results(self): + """ + Gets the parameter_results of this SearchResultsDTO. + The parameters that matched the search. + + :return: The parameter_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._parameter_results + + @parameter_results.setter + def parameter_results(self, parameter_results): + """ + Sets the parameter_results of this SearchResultsDTO. + The parameters that matched the search. + + :param parameter_results: The parameter_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._parameter_results = parameter_results + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/search_results_entity.py b/nipyapi/nifi/models/search_results_entity.py index df0f9848..898f05a6 100644 --- a/nipyapi/nifi/models/search_results_entity.py +++ b/nipyapi/nifi/models/search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_dto.py b/nipyapi/nifi/models/snippet_dto.py index 8500e95b..3de52765 100644 --- a/nipyapi/nifi/models/snippet_dto.py +++ b/nipyapi/nifi/models/snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_entity.py b/nipyapi/nifi/models/snippet_entity.py index ebddfaa4..e14ddf1a 100644 --- a/nipyapi/nifi/models/snippet_entity.py +++ b/nipyapi/nifi/models/snippet_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/start_version_control_request_entity.py b/nipyapi/nifi/models/start_version_control_request_entity.py index 8cbae61d..22f1f5fe 100644 --- a/nipyapi/nifi/models/start_version_control_request_entity.py +++ b/nipyapi/nifi/models/start_version_control_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_entry_dto.py b/nipyapi/nifi/models/state_entry_dto.py index 94ef6dcd..ef85d53e 100644 --- a/nipyapi/nifi/models/state_entry_dto.py +++ b/nipyapi/nifi/models/state_entry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_map_dto.py b/nipyapi/nifi/models/state_map_dto.py index 3dd5dc43..8b4d3ffb 100644 --- a/nipyapi/nifi/models/state_map_dto.py +++ b/nipyapi/nifi/models/state_map_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_descriptor_dto.py b/nipyapi/nifi/models/status_descriptor_dto.py index cf75511f..03e03cfe 100644 --- a/nipyapi/nifi/models/status_descriptor_dto.py +++ b/nipyapi/nifi/models/status_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_dto.py b/nipyapi/nifi/models/status_history_dto.py index ecb1f725..77e49798 100644 --- a/nipyapi/nifi/models/status_history_dto.py +++ b/nipyapi/nifi/models/status_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_entity.py b/nipyapi/nifi/models/status_history_entity.py index 910ec3bd..a44d86ed 100644 --- a/nipyapi/nifi/models/status_history_entity.py +++ b/nipyapi/nifi/models/status_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_snapshot_dto.py b/nipyapi/nifi/models/status_snapshot_dto.py index af8d54d7..bb530ba0 100644 --- a/nipyapi/nifi/models/status_snapshot_dto.py +++ b/nipyapi/nifi/models/status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/storage_usage_dto.py b/nipyapi/nifi/models/storage_usage_dto.py index 9d0ecbe7..f056fd40 100644 --- a/nipyapi/nifi/models/storage_usage_dto.py +++ b/nipyapi/nifi/models/storage_usage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/streaming_output.py b/nipyapi/nifi/models/streaming_output.py index f9509e66..1c78e22c 100644 --- a/nipyapi/nifi/models/streaming_output.py +++ b/nipyapi/nifi/models/streaming_output.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/submit_replay_request_entity.py b/nipyapi/nifi/models/submit_replay_request_entity.py index 8efa2490..5fe85285 100644 --- a/nipyapi/nifi/models/submit_replay_request_entity.py +++ b/nipyapi/nifi/models/submit_replay_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_dto.py b/nipyapi/nifi/models/system_diagnostics_dto.py index a445f410..dd2f57a5 100644 --- a/nipyapi/nifi/models/system_diagnostics_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_entity.py b/nipyapi/nifi/models/system_diagnostics_entity.py index 05b8ab7f..277324c8 100644 --- a/nipyapi/nifi/models/system_diagnostics_entity.py +++ b/nipyapi/nifi/models/system_diagnostics_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py index f527d5a8..15c19574 100644 --- a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_dto.py b/nipyapi/nifi/models/template_dto.py index 77a33958..21860da0 100644 --- a/nipyapi/nifi/models/template_dto.py +++ b/nipyapi/nifi/models/template_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_entity.py b/nipyapi/nifi/models/template_entity.py index 56a878f6..89eeb656 100644 --- a/nipyapi/nifi/models/template_entity.py +++ b/nipyapi/nifi/models/template_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/templates_entity.py b/nipyapi/nifi/models/templates_entity.py index beb8dc4f..2e7427ed 100644 --- a/nipyapi/nifi/models/templates_entity.py +++ b/nipyapi/nifi/models/templates_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_dto.py b/nipyapi/nifi/models/tenant_dto.py index fe9577dd..3f422cef 100644 --- a/nipyapi/nifi/models/tenant_dto.py +++ b/nipyapi/nifi/models/tenant_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_entity.py b/nipyapi/nifi/models/tenant_entity.py index 895d976b..b36b1fb1 100644 --- a/nipyapi/nifi/models/tenant_entity.py +++ b/nipyapi/nifi/models/tenant_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenants_entity.py b/nipyapi/nifi/models/tenants_entity.py index 3ef3e5db..5d22bf6a 100644 --- a/nipyapi/nifi/models/tenants_entity.py +++ b/nipyapi/nifi/models/tenants_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/transaction_result_entity.py b/nipyapi/nifi/models/transaction_result_entity.py index 5da3b569..f272ee90 100644 --- a/nipyapi/nifi/models/transaction_result_entity.py +++ b/nipyapi/nifi/models/transaction_result_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py index 128dda66..86c190c9 100644 --- a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py +++ b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_dto.py b/nipyapi/nifi/models/user_dto.py index 182ce080..3fe296e2 100644 --- a/nipyapi/nifi/models/user_dto.py +++ b/nipyapi/nifi/models/user_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_entity.py b/nipyapi/nifi/models/user_entity.py index fc2e2125..b164c99c 100644 --- a/nipyapi/nifi/models/user_entity.py +++ b/nipyapi/nifi/models/user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_dto.py b/nipyapi/nifi/models/user_group_dto.py index 98cf6c6d..20586b59 100644 --- a/nipyapi/nifi/models/user_group_dto.py +++ b/nipyapi/nifi/models/user_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_entity.py b/nipyapi/nifi/models/user_group_entity.py index b2d0b5af..f7cc59fd 100644 --- a/nipyapi/nifi/models/user_group_entity.py +++ b/nipyapi/nifi/models/user_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_groups_entity.py b/nipyapi/nifi/models/user_groups_entity.py index 4257b56b..10913ec1 100644 --- a/nipyapi/nifi/models/user_groups_entity.py +++ b/nipyapi/nifi/models/user_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/users_entity.py b/nipyapi/nifi/models/users_entity.py index 78890638..1ce9b882 100644 --- a/nipyapi/nifi/models/users_entity.py +++ b/nipyapi/nifi/models/users_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_dto.py b/nipyapi/nifi/models/variable_dto.py index 2f3090d7..a81874a8 100644 --- a/nipyapi/nifi/models/variable_dto.py +++ b/nipyapi/nifi/models/variable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_entity.py b/nipyapi/nifi/models/variable_entity.py index 6146b16c..eac6823d 100644 --- a/nipyapi/nifi/models/variable_entity.py +++ b/nipyapi/nifi/models/variable_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_dto.py b/nipyapi/nifi/models/variable_registry_dto.py index c858fd14..990432b5 100644 --- a/nipyapi/nifi/models/variable_registry_dto.py +++ b/nipyapi/nifi/models/variable_registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_entity.py b/nipyapi/nifi/models/variable_registry_entity.py index 00c914db..c0e7030f 100644 --- a/nipyapi/nifi/models/variable_registry_entity.py +++ b/nipyapi/nifi/models/variable_registry_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_dto.py b/nipyapi/nifi/models/variable_registry_update_request_dto.py index fe7a843c..01226e23 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -32,47 +32,51 @@ class VariableRegistryUpdateRequestDTO(object): """ swagger_types = { 'request_id': 'str', - 'process_group_id': 'str', 'uri': 'str', - 'submission_time': 'str', - 'last_updated': 'str', + 'submission_time': 'datetime', + 'last_updated': 'datetime', 'complete': 'bool', 'failure_reason': 'str', + 'percent_completed': 'int', + 'state': 'str', 'update_steps': 'list[VariableRegistryUpdateStepDTO]', + 'process_group_id': 'str', 'affected_components': 'list[AffectedComponentEntity]' } attribute_map = { 'request_id': 'requestId', - 'process_group_id': 'processGroupId', 'uri': 'uri', 'submission_time': 'submissionTime', 'last_updated': 'lastUpdated', 'complete': 'complete', 'failure_reason': 'failureReason', + 'percent_completed': 'percentCompleted', + 'state': 'state', 'update_steps': 'updateSteps', + 'process_group_id': 'processGroupId', 'affected_components': 'affectedComponents' } - def __init__(self, request_id=None, process_group_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, update_steps=None, affected_components=None): + def __init__(self, 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): """ VariableRegistryUpdateRequestDTO - a model defined in Swagger """ self._request_id = None - self._process_group_id = None self._uri = None self._submission_time = None self._last_updated = None self._complete = None self._failure_reason = None + self._percent_completed = None + self._state = None self._update_steps = None + self._process_group_id = None self._affected_components = None if request_id is not None: self.request_id = request_id - if process_group_id is not None: - self.process_group_id = process_group_id if uri is not None: self.uri = uri if submission_time is not None: @@ -83,8 +87,14 @@ def __init__(self, request_id=None, process_group_id=None, uri=None, submission_ self.complete = complete if failure_reason is not None: self.failure_reason = failure_reason + if percent_completed is not None: + self.percent_completed = percent_completed + if state is not None: + self.state = state if update_steps is not None: self.update_steps = update_steps + if process_group_id is not None: + self.process_group_id = process_group_id if affected_components is not None: self.affected_components = affected_components @@ -92,7 +102,7 @@ def __init__(self, request_id=None, process_group_id=None, uri=None, submission_ def request_id(self): """ Gets the request_id of this VariableRegistryUpdateRequestDTO. - The unique ID of this request. + The ID of the request :return: The request_id of this VariableRegistryUpdateRequestDTO. :rtype: str @@ -103,7 +113,7 @@ def request_id(self): def request_id(self, request_id): """ Sets the request_id of this VariableRegistryUpdateRequestDTO. - The unique ID of this request. + The ID of the request :param request_id: The request_id of this VariableRegistryUpdateRequestDTO. :type: str @@ -111,34 +121,11 @@ def request_id(self, request_id): self._request_id = request_id - @property - def process_group_id(self): - """ - Gets the process_group_id of this VariableRegistryUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to - - :return: The process_group_id of this VariableRegistryUpdateRequestDTO. - :rtype: str - """ - return self._process_group_id - - @process_group_id.setter - def process_group_id(self, process_group_id): - """ - Sets the process_group_id of this VariableRegistryUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to - - :param process_group_id: The process_group_id of this VariableRegistryUpdateRequestDTO. - :type: str - """ - - self._process_group_id = process_group_id - @property def uri(self): """ Gets the uri of this VariableRegistryUpdateRequestDTO. - The URI for future requests to this drop request. + The URI for the request :return: The uri of this VariableRegistryUpdateRequestDTO. :rtype: str @@ -149,7 +136,7 @@ def uri(self): def uri(self, uri): """ Sets the uri of this VariableRegistryUpdateRequestDTO. - The URI for future requests to this drop request. + The URI for the request :param uri: The uri of this VariableRegistryUpdateRequestDTO. :type: str @@ -161,10 +148,10 @@ def uri(self, uri): def submission_time(self): """ Gets the submission_time of this VariableRegistryUpdateRequestDTO. - The time at which this request was submitted. + The timestamp of when the request was submitted :return: The submission_time of this VariableRegistryUpdateRequestDTO. - :rtype: str + :rtype: datetime """ return self._submission_time @@ -172,10 +159,10 @@ def submission_time(self): def submission_time(self, submission_time): """ Sets the submission_time of this VariableRegistryUpdateRequestDTO. - The time at which this request was submitted. + The timestamp of when the request was submitted :param submission_time: The submission_time of this VariableRegistryUpdateRequestDTO. - :type: str + :type: datetime """ self._submission_time = submission_time @@ -184,10 +171,10 @@ def submission_time(self, submission_time): def last_updated(self): """ Gets the last_updated of this VariableRegistryUpdateRequestDTO. - The last time this request was updated. + The timestamp of when the request was last updated :return: The last_updated of this VariableRegistryUpdateRequestDTO. - :rtype: str + :rtype: datetime """ return self._last_updated @@ -195,10 +182,10 @@ def last_updated(self): def last_updated(self, last_updated): """ Sets the last_updated of this VariableRegistryUpdateRequestDTO. - The last time this request was updated. + The timestamp of when the request was last updated :param last_updated: The last_updated of this VariableRegistryUpdateRequestDTO. - :type: str + :type: datetime """ self._last_updated = last_updated @@ -207,7 +194,7 @@ def last_updated(self, last_updated): def complete(self): """ Gets the complete of this VariableRegistryUpdateRequestDTO. - Whether or not this request has completed + Whether or not the request is completed :return: The complete of this VariableRegistryUpdateRequestDTO. :rtype: bool @@ -218,7 +205,7 @@ def complete(self): def complete(self, complete): """ Sets the complete of this VariableRegistryUpdateRequestDTO. - Whether or not this request has completed + Whether or not the request is completed :param complete: The complete of this VariableRegistryUpdateRequestDTO. :type: bool @@ -230,7 +217,7 @@ def complete(self, complete): def failure_reason(self): """ Gets the failure_reason of this VariableRegistryUpdateRequestDTO. - An explanation of why this request failed, or null if this request has not failed + The reason for the request failing, or null if the request has not failed :return: The failure_reason of this VariableRegistryUpdateRequestDTO. :rtype: str @@ -241,7 +228,7 @@ def failure_reason(self): def failure_reason(self, failure_reason): """ Sets the failure_reason of this VariableRegistryUpdateRequestDTO. - An explanation of why this request failed, or null if this request has not failed + The reason for the request failing, or null if the request has not failed :param failure_reason: The failure_reason of this VariableRegistryUpdateRequestDTO. :type: str @@ -249,6 +236,52 @@ def failure_reason(self, failure_reason): self._failure_reason = failure_reason + @property + def percent_completed(self): + """ + Gets the percent_completed of this VariableRegistryUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :return: The percent_completed of this VariableRegistryUpdateRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this VariableRegistryUpdateRequestDTO. + A value between 0 and 100 (inclusive) indicating how close the request is to completion + + :param percent_completed: The percent_completed of this VariableRegistryUpdateRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def state(self): + """ + Gets the state of this VariableRegistryUpdateRequestDTO. + A description of the current state of the request + + :return: The state of this VariableRegistryUpdateRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this VariableRegistryUpdateRequestDTO. + A description of the current state of the request + + :param state: The state of this VariableRegistryUpdateRequestDTO. + :type: str + """ + + self._state = state + @property def update_steps(self): """ @@ -272,6 +305,29 @@ def update_steps(self, update_steps): self._update_steps = update_steps + @property + def process_group_id(self): + """ + Gets the process_group_id of this VariableRegistryUpdateRequestDTO. + The unique ID of the Process Group that the variable registry belongs to + + :return: The process_group_id of this VariableRegistryUpdateRequestDTO. + :rtype: str + """ + return self._process_group_id + + @process_group_id.setter + def process_group_id(self, process_group_id): + """ + Sets the process_group_id of this VariableRegistryUpdateRequestDTO. + The unique ID of the Process Group that the variable registry belongs to + + :param process_group_id: The process_group_id of this VariableRegistryUpdateRequestDTO. + :type: str + """ + + self._process_group_id = process_group_id + @property def affected_components(self): """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_entity.py b/nipyapi/nifi/models/variable_registry_update_request_entity.py index 1cb27581..b48eed36 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_entity.py +++ b/nipyapi/nifi/models/variable_registry_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_step_dto.py b/nipyapi/nifi/models/variable_registry_update_step_dto.py index 971bbb0e..591b61c8 100644 --- a/nipyapi/nifi/models/variable_registry_update_step_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_component_mapping_entity.py b/nipyapi/nifi/models/version_control_component_mapping_entity.py index 91095b04..21bf8e78 100644 --- a/nipyapi/nifi/models/version_control_component_mapping_entity.py +++ b/nipyapi/nifi/models/version_control_component_mapping_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_dto.py b/nipyapi/nifi/models/version_control_information_dto.py index cb18a9b2..17cadd46 100644 --- a/nipyapi/nifi/models/version_control_information_dto.py +++ b/nipyapi/nifi/models/version_control_information_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_entity.py b/nipyapi/nifi/models/version_control_information_entity.py index 8c8d5634..e7e81d3f 100644 --- a/nipyapi/nifi/models/version_control_information_entity.py +++ b/nipyapi/nifi/models/version_control_information_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_info_dto.py b/nipyapi/nifi/models/version_info_dto.py index 1079771f..bd121b13 100644 --- a/nipyapi/nifi/models/version_info_dto.py +++ b/nipyapi/nifi/models/version_info_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_connection.py b/nipyapi/nifi/models/versioned_connection.py index 2acd64e4..e44126c4 100644 --- a/nipyapi/nifi/models/versioned_connection.py +++ b/nipyapi/nifi/models/versioned_connection.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_controller_service.py b/nipyapi/nifi/models/versioned_controller_service.py index 3285a193..2a84bd26 100644 --- a/nipyapi/nifi/models/versioned_controller_service.py +++ b/nipyapi/nifi/models/versioned_controller_service.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow.py b/nipyapi/nifi/models/versioned_flow.py index 5819b23b..10531bd5 100644 --- a/nipyapi/nifi/models/versioned_flow.py +++ b/nipyapi/nifi/models/versioned_flow.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,7 +31,7 @@ class VersionedFlow(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'identifier': 'str', 'name': 'str', 'description': 'str', @@ -102,7 +102,7 @@ def link(self): An WebLink to this entity. :return: The link of this VersionedFlow. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -113,7 +113,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this VersionedFlow. - :type: Link + :type: JaxbLink """ self._link = link @@ -309,7 +309,7 @@ def type(self, type): """ if type is None: raise ValueError("Invalid value for `type`, must not be `None`") - allowed_values = ["Flow"] + allowed_values = ["Flow", "Bundle"] if type not in allowed_values: raise ValueError( "Invalid value for `type` ({0}), must be one of {1}" diff --git a/nipyapi/nifi/models/versioned_flow_coordinates.py b/nipyapi/nifi/models/versioned_flow_coordinates.py index 5fbc4da3..a975d740 100644 --- a/nipyapi/nifi/models/versioned_flow_coordinates.py +++ b/nipyapi/nifi/models/versioned_flow_coordinates.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_dto.py b/nipyapi/nifi/models/versioned_flow_dto.py index fdf7d0bf..aa5aff88 100644 --- a/nipyapi/nifi/models/versioned_flow_dto.py +++ b/nipyapi/nifi/models/versioned_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -36,7 +36,8 @@ class VersionedFlowDTO(object): 'flow_id': 'str', 'flow_name': 'str', 'description': 'str', - 'comments': 'str' + 'comments': 'str', + 'action': 'str' } attribute_map = { @@ -45,10 +46,11 @@ class VersionedFlowDTO(object): 'flow_id': 'flowId', 'flow_name': 'flowName', 'description': 'description', - 'comments': 'comments' + 'comments': 'comments', + 'action': 'action' } - def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=None, description=None, comments=None): + def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=None, description=None, comments=None, action=None): """ VersionedFlowDTO - a model defined in Swagger """ @@ -59,6 +61,7 @@ def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=Non self._flow_name = None self._description = None self._comments = None + self._action = None if registry_id is not None: self.registry_id = registry_id @@ -72,6 +75,8 @@ def __init__(self, registry_id=None, bucket_id=None, flow_id=None, flow_name=Non self.description = description if comments is not None: self.comments = comments + if action is not None: + self.action = action @property def registry_id(self): @@ -211,6 +216,35 @@ def comments(self, comments): self._comments = comments + @property + def action(self): + """ + Gets the action of this VersionedFlowDTO. + The action being performed + + :return: The action of this VersionedFlowDTO. + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """ + Sets the action of this VersionedFlowDTO. + The action being performed + + :param action: The action of this VersionedFlowDTO. + :type: str + """ + allowed_values = ["COMMIT", "FORCE_COMMIT"] + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" + .format(action, allowed_values) + ) + + self._action = action + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_flow_entity.py b/nipyapi/nifi/models/versioned_flow_entity.py index db53f82e..1a8e4c1d 100644 --- a/nipyapi/nifi/models/versioned_flow_entity.py +++ b/nipyapi/nifi/models/versioned_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot.py b/nipyapi/nifi/models/versioned_flow_snapshot.py index abe23a56..851d97ae 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,6 +33,9 @@ class VersionedFlowSnapshot(object): swagger_types = { 'snapshot_metadata': 'VersionedFlowSnapshotMetadata', 'flow_contents': 'VersionedProcessGroup', + 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', + 'parameter_contexts': 'dict(str, VersionedParameterContext)', + 'flow_encoding_version': 'str', 'flow': 'VersionedFlow', 'bucket': 'Bucket', 'latest': 'bool' @@ -41,24 +44,36 @@ class VersionedFlowSnapshot(object): attribute_map = { 'snapshot_metadata': 'snapshotMetadata', 'flow_contents': 'flowContents', + 'external_controller_services': 'externalControllerServices', + 'parameter_contexts': 'parameterContexts', + 'flow_encoding_version': 'flowEncodingVersion', 'flow': 'flow', 'bucket': 'bucket', 'latest': 'latest' } - def __init__(self, snapshot_metadata=None, flow_contents=None, flow=None, bucket=None, latest=None): + def __init__(self, snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None): """ VersionedFlowSnapshot - a model defined in Swagger """ self._snapshot_metadata = None self._flow_contents = None + self._external_controller_services = None + self._parameter_contexts = None + self._flow_encoding_version = None self._flow = None self._bucket = None self._latest = None self.snapshot_metadata = snapshot_metadata self.flow_contents = flow_contents + if external_controller_services is not None: + self.external_controller_services = external_controller_services + if parameter_contexts is not None: + self.parameter_contexts = parameter_contexts + if flow_encoding_version is not None: + self.flow_encoding_version = flow_encoding_version if flow is not None: self.flow = flow if bucket is not None: @@ -116,6 +131,75 @@ def flow_contents(self, flow_contents): self._flow_contents = flow_contents + @property + def external_controller_services(self): + """ + 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. + + :return: The external_controller_services of this VersionedFlowSnapshot. + :rtype: dict(str, ExternalControllerServiceReference) + """ + return self._external_controller_services + + @external_controller_services.setter + def external_controller_services(self, external_controller_services): + """ + Sets 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. + + :param external_controller_services: The external_controller_services of this VersionedFlowSnapshot. + :type: dict(str, ExternalControllerServiceReference) + """ + + self._external_controller_services = external_controller_services + + @property + def parameter_contexts(self): + """ + 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. + + :return: The parameter_contexts of this VersionedFlowSnapshot. + :rtype: dict(str, VersionedParameterContext) + """ + return self._parameter_contexts + + @parameter_contexts.setter + def parameter_contexts(self, parameter_contexts): + """ + Sets 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. + + :param parameter_contexts: The parameter_contexts of this VersionedFlowSnapshot. + :type: dict(str, VersionedParameterContext) + """ + + self._parameter_contexts = parameter_contexts + + @property + def flow_encoding_version(self): + """ + Gets the flow_encoding_version of this VersionedFlowSnapshot. + The optional encoding version of the flow contents. + + :return: The flow_encoding_version of this VersionedFlowSnapshot. + :rtype: str + """ + return self._flow_encoding_version + + @flow_encoding_version.setter + def flow_encoding_version(self, flow_encoding_version): + """ + Sets the flow_encoding_version of this VersionedFlowSnapshot. + The optional encoding version of the flow contents. + + :param flow_encoding_version: The flow_encoding_version of this VersionedFlowSnapshot. + :type: str + """ + + self._flow_encoding_version = flow_encoding_version + @property def flow(self): """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py index 6ed0af57..df19d8b4 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py index 61fe1bad..1558c7ab 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,7 +31,7 @@ class VersionedFlowSnapshotMetadata(object): and the value is json key in definition. """ swagger_types = { - 'link': 'Link', + 'link': 'JaxbLink', 'bucket_identifier': 'str', 'flow_identifier': 'str', 'version': 'int', @@ -82,7 +82,7 @@ def link(self): An WebLink to this entity. :return: The link of this VersionedFlowSnapshotMetadata. - :rtype: Link + :rtype: JaxbLink """ return self._link @@ -93,7 +93,7 @@ def link(self, link): An WebLink to this entity. :param link: The link of this VersionedFlowSnapshotMetadata. - :type: Link + :type: JaxbLink """ self._link = link @@ -170,8 +170,8 @@ def version(self, version): """ if version is None: raise ValueError("Invalid value for `version`, must not be `None`") - if version is not None and version < 1: - raise ValueError("Invalid value for `version`, must be a value greater than or equal to `1`") + if version is not None and version < -1: + raise ValueError("Invalid value for `version`, must be a value greater than or equal to `-1`") self._version = version diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py index 010b9022..fba55a20 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py index d83e97f5..656e68cd 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_dto.py b/nipyapi/nifi/models/versioned_flow_update_request_dto.py index 523915b3..6dd65c37 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_dto.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_entity.py b/nipyapi/nifi/models/versioned_flow_update_request_entity.py index 0d3239aa..56b56c63 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_entity.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flows_entity.py b/nipyapi/nifi/models/versioned_flows_entity.py index 9917dab1..c5dbeb6b 100644 --- a/nipyapi/nifi/models/versioned_flows_entity.py +++ b/nipyapi/nifi/models/versioned_flows_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_funnel.py b/nipyapi/nifi/models/versioned_funnel.py index bc5450ef..1d6c467c 100644 --- a/nipyapi/nifi/models/versioned_funnel.py +++ b/nipyapi/nifi/models/versioned_funnel.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_label.py b/nipyapi/nifi/models/versioned_label.py index 58a271c8..03a12374 100644 --- a/nipyapi/nifi/models/versioned_label.py +++ b/nipyapi/nifi/models/versioned_label.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter.py b/nipyapi/nifi/models/versioned_parameter.py new file mode 100644 index 00000000..527d4cf8 --- /dev/null +++ b/nipyapi/nifi/models/versioned_parameter.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedParameter(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'sensitive': 'bool', + 'value': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'sensitive': 'sensitive', + 'value': 'value' + } + + def __init__(self, name=None, description=None, sensitive=None, value=None): + """ + VersionedParameter - a model defined in Swagger + """ + + self._name = None + self._description = None + self._sensitive = None + self._value = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if sensitive is not None: + self.sensitive = sensitive + if value is not None: + self.value = value + + @property + def name(self): + """ + Gets the name of this VersionedParameter. + The name of the parameter + + :return: The name of this VersionedParameter. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedParameter. + The name of the parameter + + :param name: The name of this VersionedParameter. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this VersionedParameter. + The description of the param + + :return: The description of this VersionedParameter. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VersionedParameter. + The description of the param + + :param description: The description of this VersionedParameter. + :type: str + """ + + self._description = description + + @property + def sensitive(self): + """ + Gets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :return: The sensitive of this VersionedParameter. + :rtype: bool + """ + return self._sensitive + + @sensitive.setter + def sensitive(self, sensitive): + """ + Sets the sensitive of this VersionedParameter. + Whether or not the parameter value is sensitive + + :param sensitive: The sensitive of this VersionedParameter. + :type: bool + """ + + self._sensitive = sensitive + + @property + def value(self): + """ + Gets the value of this VersionedParameter. + The value of the parameter + + :return: The value of this VersionedParameter. + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """ + Sets the value of this VersionedParameter. + The value of the parameter + + :param value: The value of this VersionedParameter. + :type: str + """ + + self._value = value + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedParameter): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/versioned_parameter_context.py b/nipyapi/nifi/models/versioned_parameter_context.py new file mode 100644 index 00000000..e6154bbf --- /dev/null +++ b/nipyapi/nifi/models/versioned_parameter_context.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.10.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedParameterContext(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'parameters': 'list[VersionedParameter]' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'parameters': 'parameters' + } + + def __init__(self, name=None, description=None, parameters=None): + """ + VersionedParameterContext - a model defined in Swagger + """ + + self._name = None + self._description = None + self._parameters = None + + if name is not None: + self.name = name + if description is not None: + self.description = description + if parameters is not None: + self.parameters = parameters + + @property + def name(self): + """ + Gets the name of this VersionedParameterContext. + The name of the context + + :return: The name of this VersionedParameterContext. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedParameterContext. + The name of the context + + :param name: The name of this VersionedParameterContext. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this VersionedParameterContext. + The description of the parameter context + + :return: The description of this VersionedParameterContext. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this VersionedParameterContext. + The description of the parameter context + + :param description: The description of this VersionedParameterContext. + :type: str + """ + + self._description = description + + @property + def parameters(self): + """ + Gets the parameters of this VersionedParameterContext. + The parameters in the context + + :return: The parameters of this VersionedParameterContext. + :rtype: list[VersionedParameter] + """ + return self._parameters + + @parameters.setter + def parameters(self, parameters): + """ + Sets the parameters of this VersionedParameterContext. + The parameters in the context + + :param parameters: The parameters of this VersionedParameterContext. + :type: list[VersionedParameter] + """ + + self._parameters = parameters + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedParameterContext): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/versioned_port.py b/nipyapi/nifi/models/versioned_port.py index f349b47d..b4b5718d 100644 --- a/nipyapi/nifi/models/versioned_port.py +++ b/nipyapi/nifi/models/versioned_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -37,6 +37,8 @@ class VersionedPort(object): 'position': 'Position', 'type': 'str', 'concurrently_schedulable_task_count': 'int', + 'scheduled_state': 'str', + 'allow_remote_access': 'bool', 'component_type': 'str', 'group_identifier': 'str' } @@ -48,11 +50,13 @@ class VersionedPort(object): 'position': 'position', 'type': 'type', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', + 'scheduled_state': 'scheduledState', + 'allow_remote_access': 'allowRemoteAccess', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, component_type=None, group_identifier=None): + def __init__(self, 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): """ VersionedPort - a model defined in Swagger """ @@ -63,6 +67,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, typ self._position = None self._type = None self._concurrently_schedulable_task_count = None + self._scheduled_state = None + self._allow_remote_access = None self._component_type = None self._group_identifier = None @@ -78,6 +84,10 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, typ self.type = type if concurrently_schedulable_task_count is not None: self.concurrently_schedulable_task_count = concurrently_schedulable_task_count + if scheduled_state is not None: + self.scheduled_state = scheduled_state + if allow_remote_access is not None: + self.allow_remote_access = allow_remote_access if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -227,6 +237,58 @@ def concurrently_schedulable_task_count(self, concurrently_schedulable_task_coun self._concurrently_schedulable_task_count = concurrently_schedulable_task_count + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedPort. + The scheduled state of the component + + :return: The scheduled_state of this VersionedPort. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedPort. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedPort. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + + @property + def allow_remote_access(self): + """ + Gets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :return: The allow_remote_access of this VersionedPort. + :rtype: bool + """ + return self._allow_remote_access + + @allow_remote_access.setter + def allow_remote_access(self, allow_remote_access): + """ + Sets the allow_remote_access of this VersionedPort. + Whether or not this port allows remote access for site-to-site + + :param allow_remote_access: The allow_remote_access of this VersionedPort. + :type: bool + """ + + self._allow_remote_access = allow_remote_access + @property def component_type(self): """ diff --git a/nipyapi/nifi/models/versioned_process_group.py b/nipyapi/nifi/models/versioned_process_group.py index 4941d000..933c9439 100644 --- a/nipyapi/nifi/models/versioned_process_group.py +++ b/nipyapi/nifi/models/versioned_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -46,6 +46,7 @@ class VersionedProcessGroup(object): 'controller_services': 'list[VersionedControllerService]', 'versioned_flow_coordinates': 'VersionedFlowCoordinates', 'variables': 'dict(str, str)', + 'parameter_context_name': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -66,11 +67,12 @@ class VersionedProcessGroup(object): 'controller_services': 'controllerServices', 'versioned_flow_coordinates': 'versionedFlowCoordinates', 'variables': 'variables', + 'parameter_context_name': 'parameterContextName', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, component_type=None, group_identifier=None): + def __init__(self, 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, component_type=None, group_identifier=None): """ VersionedProcessGroup - a model defined in Swagger """ @@ -90,6 +92,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self._controller_services = None self._versioned_flow_coordinates = None self._variables = None + self._parameter_context_name = None self._component_type = None self._group_identifier = None @@ -123,6 +126,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self.versioned_flow_coordinates = versioned_flow_coordinates if variables is not None: self.variables = variables + if parameter_context_name is not None: + self.parameter_context_name = parameter_context_name if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -473,6 +478,29 @@ def variables(self, variables): self._variables = variables + @property + def parameter_context_name(self): + """ + Gets the parameter_context_name of this VersionedProcessGroup. + The name of the parameter context used by this process group + + :return: The parameter_context_name of this VersionedProcessGroup. + :rtype: str + """ + return self._parameter_context_name + + @parameter_context_name.setter + def parameter_context_name(self, parameter_context_name): + """ + Sets the parameter_context_name of this VersionedProcessGroup. + The name of the parameter context used by this process group + + :param parameter_context_name: The parameter_context_name of this VersionedProcessGroup. + :type: str + """ + + self._parameter_context_name = parameter_context_name + @property def component_type(self): """ diff --git a/nipyapi/nifi/models/versioned_processor.py b/nipyapi/nifi/models/versioned_processor.py index 7011410f..cdc04227 100644 --- a/nipyapi/nifi/models/versioned_processor.py +++ b/nipyapi/nifi/models/versioned_processor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -50,6 +50,7 @@ class VersionedProcessor(object): 'run_duration_millis': 'int', 'concurrently_schedulable_task_count': 'int', 'auto_terminated_relationships': 'list[str]', + 'scheduled_state': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -74,11 +75,12 @@ class VersionedProcessor(object): 'run_duration_millis': 'runDurationMillis', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'auto_terminated_relationships': 'autoTerminatedRelationships', + 'scheduled_state': 'scheduledState', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, name=None, comments=None, position=None, bundle=None, style=None, type=None, properties=None, property_descriptors=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, component_type=None, group_identifier=None): + def __init__(self, identifier=None, name=None, comments=None, position=None, bundle=None, style=None, type=None, properties=None, property_descriptors=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, component_type=None, group_identifier=None): """ VersionedProcessor - a model defined in Swagger """ @@ -102,6 +104,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, bun self._run_duration_millis = None self._concurrently_schedulable_task_count = None self._auto_terminated_relationships = None + self._scheduled_state = None self._component_type = None self._group_identifier = None @@ -143,6 +146,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, bun self.concurrently_schedulable_task_count = concurrently_schedulable_task_count if auto_terminated_relationships is not None: self.auto_terminated_relationships = auto_terminated_relationships + if scheduled_state is not None: + self.scheduled_state = scheduled_state if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -585,6 +590,35 @@ def auto_terminated_relationships(self, auto_terminated_relationships): self._auto_terminated_relationships = auto_terminated_relationships + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedProcessor. + The scheduled state of the component + + :return: The scheduled_state of this VersionedProcessor. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedProcessor. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedProcessor. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + @property def component_type(self): """ diff --git a/nipyapi/nifi/models/versioned_property_descriptor.py b/nipyapi/nifi/models/versioned_property_descriptor.py index 199a378b..152334d8 100644 --- a/nipyapi/nifi/models/versioned_property_descriptor.py +++ b/nipyapi/nifi/models/versioned_property_descriptor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_group_port.py b/nipyapi/nifi/models/versioned_remote_group_port.py index d5da6963..d4aea84b 100644 --- a/nipyapi/nifi/models/versioned_remote_group_port.py +++ b/nipyapi/nifi/models/versioned_remote_group_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,6 +41,7 @@ class VersionedRemoteGroupPort(object): 'batch_size': 'BatchSize', 'component_type': 'str', 'target_id': 'str', + 'scheduled_state': 'str', 'group_identifier': 'str' } @@ -55,10 +56,11 @@ class VersionedRemoteGroupPort(object): 'batch_size': 'batchSize', 'component_type': 'componentType', 'target_id': 'targetId', + 'scheduled_state': 'scheduledState', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, group_identifier=None): + def __init__(self, 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): """ VersionedRemoteGroupPort - a model defined in Swagger """ @@ -73,6 +75,7 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, rem self._batch_size = None self._component_type = None self._target_id = None + self._scheduled_state = None self._group_identifier = None if identifier is not None: @@ -95,6 +98,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, rem self.component_type = component_type if target_id is not None: self.target_id = target_id + if scheduled_state is not None: + self.scheduled_state = scheduled_state if group_identifier is not None: self.group_identifier = group_identifier @@ -332,6 +337,35 @@ def target_id(self, target_id): self._target_id = target_id + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component + + :return: The scheduled_state of this VersionedRemoteGroupPort. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedRemoteGroupPort. + The scheduled state of the component + + :param scheduled_state: The scheduled_state of this VersionedRemoteGroupPort. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + @property def group_identifier(self): """ diff --git a/nipyapi/nifi/models/versioned_remote_process_group.py b/nipyapi/nifi/models/versioned_remote_process_group.py index 4ea33c0f..d52562c7 100644 --- a/nipyapi/nifi/models/versioned_remote_process_group.py +++ b/nipyapi/nifi/models/versioned_remote_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index 2d2da280..12300be8 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.9.1 + OpenAPI spec version: 1.10.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 357adb4b..0425010e 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -248,7 +248,8 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, description=desc, flow_name=flow_name, flow_id=flow_id, - registry_id=registry_client.id + registry_id=registry_client.id, + action='COMMIT' ) ) ) diff --git a/resources/client_gen/api_defs/nifi-1.10.0-swagger.json b/resources/client_gen/api_defs/nifi-1.10.0-swagger.json new file mode 100644 index 00000000..4cc80c43 --- /dev/null +++ b/resources/client_gen/api_defs/nifi-1.10.0-swagger.json @@ -0,0 +1,20603 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", + "version" : "1.10.0", + "title" : "NiFi Rest Api", + "contact" : { + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-api", + "tags" : [ { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "connections", + "description" : "Endpoint for managing a Connection." + }, { + "name" : "controller", + "description" : "Provides realtime command and control of this NiFi instance" + }, { + "name" : "controller-services", + "description" : "Endpoint for managing a Controller Service." + }, { + "name" : "counters", + "description" : "Endpoint for managing counters." + }, { + "name" : "data-transfer", + "description" : "Supports data transfers with this NiFi using HTTP based site to site" + }, { + "name" : "flow", + "description" : "Endpoint for accessing the flow structure and component status." + }, { + "name" : "flowfile-queues", + "description" : "Endpoint for managing a FlowFile Queue." + }, { + "name" : "funnel", + "description" : "Endpoint for managing a Funnel." + }, { + "name" : "input-ports", + "description" : "Endpoint for managing an Input Port." + }, { + "name" : "labels", + "description" : "Endpoint for managing a Label." + }, { + "name" : "output-ports", + "description" : "Endpoint for managing an Output Port." + }, { + "name" : "parameter-contexts", + "description" : "Endpoint for managing version control for a flow" + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "process-groups", + "description" : "Endpoint for managing a Process Group." + }, { + "name" : "processors", + "description" : "Endpoint for managing a Processor." + }, { + "name" : "provenance", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "provenance-events", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "remote-process-groups", + "description" : "Endpoint for managing a Remote Process Group." + }, { + "name" : "reporting-tasks", + "description" : "Endpoint for managing a Reporting Task." + }, { + "name" : "resources", + "description" : "Provides the resources in this NiFi that can have access/authorization policies." + }, { + "name" : "site-to-site", + "description" : "Provide access to site to site with this NiFi" + }, { + "name" : "snippets", + "description" : "Endpoint for accessing dataflow snippets." + }, { + "name" : "system-diagnostics", + "description" : "Endpoint for accessing system diagnostics." + }, { + "name" : "templates", + "description" : "Endpoint for managing a Template." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + }, { + "name" : "versions", + "description" : "Endpoint for managing version control for a flow" + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Gets the status the client's access", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Unable to determine access status because the client could not be authenticated." + }, + "403" : { + "description" : "Unable to determine access status because the client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to determine access status because NiFi is not in the appropriate state." + }, + "500" : { + "description" : "Unable to determine access status because an unexpected error occurred." + } + } + } + }, + "/access/config" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Retrieves the access configuration for this NiFi", + "description" : "", + "operationId" : "getLoginConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessConfigurationEntity" + } + } + } + } + }, + "/access/download-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for downloading FlowFile content.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createDownloadToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/access/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", + "description" : "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 '.", + "operationId" : "createAccessTokenFromTicket", + "consumes" : [ "text/plain" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/knox/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/logout" : { + "delete" : { + "tags" : [ "access" ], + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOut", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/oidc/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/exchange" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcExchange", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + } + } + } + }, + "/access/oidc/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the OpenId Provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via username/password", + "description" : "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 '.", + "operationId" : "createAccessToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "username", + "in" : "formData", + "required" : false, + "type" : "string" + }, { + "name" : "password", + "in" : "formData", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/ui-extension-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for accessing a NiFi UI extension.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createUiExtensionToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/connections/{id}" : { + "get" : { + "tags" : [ "connections" ], + "summary" : "Gets a connection", + "description" : "", + "operationId" : "getConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source - /{component-type}/{uuid}" : [ ] + }, { + "Read Destination - /{component-type}/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "connections" ], + "summary" : "Updates a connection", + "description" : "", + "operationId" : "updateConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + }, { + "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] + }, { + "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] + } ] + }, + "delete" : { + "tags" : [ "connections" ], + "summary" : "Deletes a connection", + "description" : "", + "operationId" : "deleteConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller service", + "description" : "", + "operationId" : "updateControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller-services" ], + "summary" : "Deletes a controller service", + "description" : "", + "operationId" : "removeControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - Controller if scoped by Controller - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/descriptors" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name to return the descriptor for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/references" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerServiceReferences", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller services references", + "description" : "", + "operationId" : "updateControllerServiceReferences", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service request update request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] + } ] + } + }, + "/controller-services/{id}/run-status" : { + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates run status of a controller service", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets the state for a controller service", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "controller-services" ], + "summary" : "Clears the state for a controller service", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller/bulletin" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new bulletin", + "description" : "", + "operationId" : "createBulletin", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/cluster" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the contents of the cluster", + "description" : "Returns the contents of the cluster including all nodes and their status.", + "operationId" : "getCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + } + }, + "/controller/cluster/nodes/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a node in the cluster", + "description" : "", + "operationId" : "getNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a node in the cluster", + "description" : "", + "operationId" : "updateNode", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Removes a node from the cluster", + "description" : "", + "operationId" : "deleteNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/config" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi Controller", + "description" : "", + "operationId" : "getControllerConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi", + "description" : "", + "operationId" : "updateControllerConfig", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/controller-services" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/controller/history" : { + "delete" : { + "tags" : [ "controller" ], + "summary" : "Purges history", + "description" : "", + "operationId" : "deleteHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "endDate", + "in" : "query", + "description" : "Purge actions before this date/time.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the listing of available registry clients", + "description" : "", + "operationId" : "getRegistryClients", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new registry client", + "description" : "", + "operationId" : "createRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a registry client", + "description" : "", + "operationId" : "getRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a registry client", + "description" : "", + "operationId" : "updateRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Deletes a registry client", + "description" : "", + "operationId" : "deleteRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/reporting-tasks" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new reporting task", + "description" : "", + "operationId" : "createReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Reporting Task is restricted - /restricted-components" : [ ] + } ] + } + }, + "/counters" : { + "get" : { + "tags" : [ "counters" ], + "summary" : "Gets the current counters for this NiFi", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getCounters", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CountersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /counters" : [ ] + } ] + } + }, + "/counters/{id}" : { + "put" : { + "tags" : [ "counters" ], + "summary" : "Updates the specified counter. This will reset the counter value to 0", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateCounter", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The id of the counter.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CounterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /counters" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendInputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitInputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files to the input port", + "description" : "", + "operationId" : "receiveFlowFiles", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendOutputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitOutputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "checksum", + "in" : "query", + "description" : "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" : true, + "type" : "string" + }, { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { + "get" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files from the output port", + "description" : "", + "operationId" : "transferFlowFiles", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "There is no flow file to return.", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/{portType}/{portId}/transactions" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Create a transaction to the specified output port or input port", + "description" : "", + "operationId" : "createPortTransaction", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portType", + "in" : "path", + "description" : "The port type.", + "required" : true, + "type" : "string", + "enum" : [ "input-ports", "output-ports" ] + }, { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/about" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves details about this NiFi to put in the About dialog", + "description" : "", + "operationId" : "getAboutInfo", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AboutEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/banners" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the banners for this NiFi", + "description" : "", + "operationId" : "getBanners", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BannerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/bulletin-board" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets current bulletins", + "description" : "", + "operationId" : "getBulletinBoard", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "Includes bulletins with an id after this value.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceName", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose name match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "message", + "in" : "query", + "description" : "Includes bulletins whose message that match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "limit", + "in" : "query", + "description" : "The number of bulletins to limit the response to.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinBoardEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] + } ] + } + }, + "/flow/client-id" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Generates a client id.", + "description" : "", + "operationId" : "generateClientId", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Searches the cluster for a node with the specified address", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Node address to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterSearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/summary" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "The cluster summary for this NiFi", + "description" : "", + "operationId" : "getClusterSummary", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusteSummaryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/config" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the configuration for this NiFi flow", + "description" : "", + "operationId" : "getFlowConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/statistics" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets statistics for a connection", + "description" : "", + "operationId" : "getConnectionStatistics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the statistics.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatisticsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a connection", + "description" : "", + "operationId" : "getConnectionStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history for a connection", + "description" : "", + "operationId" : "getConnectionStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller-service-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of controller services that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getControllerServiceTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "serviceType", + "in" : "query", + "description" : "If specified, will only return controller services that are compatible with this type of service.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleGroup", + "in" : "query", + "description" : "If serviceType specified, is the bundle group of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleArtifact", + "in" : "query", + "description" : "If serviceType specified, is the bundle artifact of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleVersion", + "in" : "query", + "description" : "If serviceType specified, is the bundle version of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "typeFilter", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller/bulletins" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves Controller level bulletins", + "description" : "", + "operationId" : "getBulletins", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerBulletinsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /controller - For controller bulletins" : [ ] + }, { + "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] + }, { + "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] + } ] + } + }, + "/flow/controller/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets controller services for reporting tasks", + "description" : "", + "operationId" : "getControllerServicesFromController", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/current-user" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the user identity of the user making the request", + "description" : "", + "operationId" : "getCurrentUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUserEntity" + } + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "queryHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "The offset into the result set.", + "required" : true, + "type" : "string" + }, { + "name" : "count", + "in" : "query", + "description" : "The number of actions to return.", + "required" : true, + "type" : "string" + }, { + "name" : "sortColumn", + "in" : "query", + "description" : "The field to sort on.", + "required" : false, + "type" : "string" + }, { + "name" : "sortOrder", + "in" : "query", + "description" : "The direction to sort.", + "required" : false, + "type" : "string" + }, { + "name" : "startDate", + "in" : "query", + "description" : "Include actions after this date.", + "required" : false, + "type" : "string" + }, { + "name" : "endDate", + "in" : "query", + "description" : "Include actions before this date.", + "required" : false, + "type" : "string" + }, { + "name" : "userIdentity", + "in" : "query", + "description" : "Include actions performed by this user.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Include actions on this component.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history/components/{componentId}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history for a component", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getComponentHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "componentId", + "in" : "path", + "description" : "The component id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read underlying component - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/history/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets an action", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAction", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The action id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/input-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an input port", + "description" : "", + "operationId" : "getInputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/output-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an output port", + "description" : "", + "operationId" : "getOutputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/parameter-contexts" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all Parameter Contexts", + "description" : "", + "operationId" : "getParameterContexts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] + } ] + } + }, + "/flow/prioritizers" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of prioritizers that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getPrioritizers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PrioritizerTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupFlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Schedule or unschedule components in the specified Process Group.", + "description" : "", + "operationId" : "scheduleComponents", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all controller services", + "description" : "", + "operationId" : "getControllerServicesFromGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include parent/ancestory process groups", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Enable or disable Controller Services in the specified Process Group.", + "description" : "", + "operationId" : "activateControllerServices", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status for a process group", + "description" : "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.", + "operationId" : "getProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "recursive", + "in" : "query", + "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a remote process group", + "description" : "", + "operationId" : "getProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processor-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of processors that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a processor", + "description" : "", + "operationId" : "getProcessorStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a processor", + "description" : "", + "operationId" : "getProcessorStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the listing of available registries", + "description" : "", + "operationId" : "getRegistries", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{id}/buckets" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the buckets from the specified registry for the current user", + "description" : "", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BucketsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flows from the specified registry and bucket for the current user", + "description" : "", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", + "description" : "", + "operationId" : "getVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + }, { + "name" : "flow-id", + "in" : "path", + "description" : "The flow id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history", + "description" : "", + "operationId" : "getRemoteProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-task-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of reporting tasks that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReportingTaskTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-tasks" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all reporting tasks", + "description" : "", + "operationId" : "getReportingTasks", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTasksEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Performs a search against this NiFi using the specified search term", + "description" : "Only search results from authorized components will be returned.", + "operationId" : "searchFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the current status of this NiFi", + "description" : "", + "operationId" : "getControllerStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/templates" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all templates", + "description" : "", + "operationId" : "getTemplates", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplatesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Creates a request to drop the contents of the queue in this connection.", + "description" : "", + "operationId" : "createDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a drop request for the specified connection.", + "description" : "", + "operationId" : "getDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to drop the contents of this connection.", + "description" : "", + "operationId" : "removeDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets a FlowFile from a Connection.", + "description" : "", + "operationId" : "getFlowFile", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowFileEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the content for a FlowFile in a Connection.", + "description" : "", + "operationId" : "downloadFlowFileContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Lists the contents of the queue in this connection.", + "description" : "", + "operationId" : "createFlowFileListing", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a listing request for the specified connection.", + "description" : "", + "operationId" : "getListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to list the contents of this connection.", + "description" : "", + "operationId" : "deleteListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/funnels/{id}" : { + "get" : { + "tags" : [ "funnel" ], + "summary" : "Gets a funnel", + "description" : "", + "operationId" : "getFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /funnels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "funnel" ], + "summary" : "Updates a funnel", + "description" : "", + "operationId" : "updateFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "funnel" ], + "summary" : "Deletes a funnel", + "description" : "", + "operationId" : "removeFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}" : { + "get" : { + "tags" : [ "input-ports" ], + "summary" : "Gets an input port", + "description" : "", + "operationId" : "getInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /input-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates an input port", + "description" : "", + "operationId" : "updateInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "input-ports" ], + "summary" : "Deletes an input port", + "description" : "", + "operationId" : "removeInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}/run-status" : { + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates run status of an input-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] + } ] + } + }, + "/labels/{id}" : { + "get" : { + "tags" : [ "labels" ], + "summary" : "Gets a label", + "description" : "", + "operationId" : "getLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /labels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "labels" ], + "summary" : "Updates a label", + "description" : "", + "operationId" : "updateLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "labels" ], + "summary" : "Deletes a label", + "description" : "", + "operationId" : "removeLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}" : { + "get" : { + "tags" : [ "output-ports" ], + "summary" : "Gets an output port", + "description" : "", + "operationId" : "getOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /output-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates an output port", + "description" : "", + "operationId" : "updateOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "output-ports" ], + "summary" : "Deletes an output port", + "description" : "", + "operationId" : "removeOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}/run-status" : { + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates run status of an output-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] + } ] + } + }, + "/parameter-contexts" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Create a Parameter Context", + "description" : "", + "operationId" : "createParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The Parameter Context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-contexts" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate the Update Request of a Parameter Context", + "description" : "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 acttion 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}.", + "operationId" : "submitParameterContextUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated version of the parameter context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Write - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests/{requestId}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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. ", + "operationId" : "getParameterContextUpdate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the ParameterContext", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", + "description" : "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}.", + "operationId" : "submitValidationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The validation request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Validation Request with the given ID", + "description" : "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. ", + "operationId" : "getValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Validation Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Validation Request with the given ID", + "description" : "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.", + "operationId" : "deleteValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Parameter Context with the given ID", + "description" : "Returns the Parameter Context with the given ID.", + "operationId" : "getParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ] + }, + "put" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Modifies a Parameter Context", + "description" : "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.", + "operationId" : "updateParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated Parameter Context", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + }, { + "Write - /parameter-contexts/{id}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Parameter Context with the given ID", + "description" : "Deletes the Parameter Context with the given ID.", + "operationId" : "deleteParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The Parameter Context ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{uuid}" : [ ] + }, { + "Write - /parameter-contexts/{uuid}" : [ ] + }, { + "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + }, { + "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + } ] + } + }, + "/policies" : { + "post" : { + "tags" : [ "policies" ], + "summary" : "Creates an access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy for the specified action and resource", + "description" : "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.", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Updates a access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Deletes an access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + }, { + "Write - Policy of the parent resource - /policies/{resource}" : [ ] + } ] + } + }, + "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates a process group", + "description" : "", + "operationId" : "updateProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes a process group", + "description" : "", + "operationId" : "removeProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/connections" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all connections", + "description" : "", + "operationId" : "getConnections", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a connection", + "description" : "", + "operationId" : "createConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/controller-services" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/funnels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all funnels", + "description" : "", + "operationId" : "getFunnels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a funnel", + "description" : "", + "operationId" : "createFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/input-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all input ports", + "description" : "", + "operationId" : "getInputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/InputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an input port", + "description" : "", + "operationId" : "createInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/labels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all labels", + "description" : "", + "operationId" : "getLabels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a label", + "description" : "", + "operationId" : "createLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/local-modifications" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", + "description" : "", + "operationId" : "getLocalModifications", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowComparisonEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/output-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all output ports", + "description" : "", + "operationId" : "getOutputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/OutputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an output port", + "description" : "", + "operationId" : "createOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all process groups", + "description" : "", + "operationId" : "getProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a process group", + "description" : "", + "operationId" : "createProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/processors" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all processors", + "description" : "", + "operationId" : "getProcessors", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include processors from descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new processor", + "description" : "", + "operationId" : "createProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Processor is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/remote-process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all remote process groups", + "description" : "", + "operationId" : "getRemoteProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new process group", + "description" : "", + "operationId" : "createRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/snippet-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Copies a snippet and discards it.", + "description" : "", + "operationId" : "copySnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The copy snippet request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CopySnippetRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + }, { + "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/template-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Instantiates a template", + "description" : "", + "operationId" : "instantiateTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The instantiate template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/InstantiateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /templates/{uuid}" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a template and discards the specified snippet.", + "description" : "", + "operationId" : "createTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The create template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/import" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Imports a template", + "description" : "", + "operationId" : "importTemplate", + "consumes" : [ "application/xml" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/upload" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Uploads a template", + "description" : "", + "operationId" : "uploadTemplate", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "template", + "in" : "formData", + "description" : "The binary content of the template file being uploaded.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistry", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include ancestor groups", + "required" : false, + "type" : "boolean", + "default" : true + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates the contents of a Process Group's variable Registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVariableRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry/update-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Submits a request to update a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "submitUpdateVariableRegistryRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets a processor", + "description" : "", + "operationId" : "getProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates a processor", + "description" : "", + "operationId" : "updateProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "processors" ], + "summary" : "Deletes a processor", + "description" : "", + "operationId" : "deleteProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/descriptors" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the descriptor for a processor property", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/diagnostics" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets diagnostics information about a processor", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/run-status" : { + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates run status of a processor", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the state for a processor", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Clears the state for a processor", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/threads" : { + "delete" : { + "tags" : [ "processors" ], + "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", + "description" : "", + "operationId" : "terminateProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/provenance" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a provenance query", + "description" : "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.", + "operationId" : "submitProvenanceRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The provenance query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/replays" : { + "post" : { + "tags" : [ "provenance-events" ], + "summary" : "Replays content from a provenance event", + "description" : "", + "operationId" : "submitReplay", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The replay request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SubmitReplayRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets a provenance event", + "description" : "", + "operationId" : "getProvenanceEvent", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this event exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/input" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the input content for a provenance event", + "description" : "", + "operationId" : "getInputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/output" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the output content for a provenance event", + "description" : "", + "operationId" : "getOutputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a lineage query", + "description" : "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.", + "operationId" : "submitLineageRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The lineage query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a lineage query", + "description" : "", + "operationId" : "getLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a lineage query", + "description" : "", + "operationId" : "deleteLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/search-options" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets the searchable attributes for provenance events", + "description" : "", + "operationId" : "getSearchOptions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceOptionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a provenance query", + "description" : "", + "operationId" : "getProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "summarize", + "in" : "query", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "incrementalResults", + "in" : "query", + "description" : "Whether or not to summarize provenance events returned. This property is false by default.", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a provenance query", + "description" : "", + "operationId" : "deleteProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/remote-process-groups/{id}" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Deletes a remote process group", + "description" : "", + "operationId" : "removeRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroupRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/state" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets the state for a RemoteProcessGroup", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task", + "description" : "", + "operationId" : "getReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates a reporting task", + "description" : "", + "operationId" : "updateReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Deletes a reporting task", + "description" : "", + "operationId" : "removeReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/descriptors" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/run-status" : { + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates run status of a reporting task", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets the state for a reporting task", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Clears the state for a reporting task", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/resources" : { + "get" : { + "tags" : [ "resources" ], + "summary" : "Gets the available resources that support access/authorization policies", + "description" : "", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ResourcesEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /resources" : [ ] + } ] + } + }, + "/site-to-site" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the details about this NiFi necessary to communicate via site to site", + "description" : "", + "operationId" : "getSiteToSiteDetails", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/site-to-site/peers" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the available Peers and its status of this NiFi", + "description" : "", + "operationId" : "getPeers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json", "application/xml" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PeersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/snippets" : { + "post" : { + "tags" : [ "snippets" ], + "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", + "description" : "", + "operationId" : "createSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] + } ] + } + }, + "/snippets/{id}" : { + "put" : { + "tags" : [ "snippets" ], + "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", + "description" : "", + "operationId" : "updateSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + } ] + }, + "delete" : { + "tags" : [ "snippets" ], + "summary" : "Deletes the components in a snippet and discards the snippet", + "description" : "", + "operationId" : "deleteSnippet", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/system-diagnostics" : { + "get" : { + "tags" : [ "system-diagnostics" ], + "summary" : "Gets the diagnostics for the system NiFi is running on", + "description" : "", + "operationId" : "getSystemDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SystemDiagnosticsEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ] + } + }, + "/templates/{id}" : { + "delete" : { + "tags" : [ "templates" ], + "summary" : "Deletes a template", + "description" : "", + "operationId" : "removeTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /templates/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/templates/{id}/download" : { + "get" : { + "tags" : [ "templates" ], + "summary" : "Exports a template", + "description" : "", + "operationId" : "exportTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /templates/{uuid}" : [ ] + } ] + } + }, + "/tenants/search-results" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Searches for a tenant with the specified identity", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchTenants", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Identity to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TenantsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all user groups", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all users", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UsersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/versions/active-requests" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Create a version control request", + "description" : "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.", + "operationId" : "createVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateActiveRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/active-requests/{id}" : { + "put" : { + "tags" : [ "versions" ], + "summary" : "Updates the request with the given ID", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The version control component mapping.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlComponentMappingEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can update it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the version control request with the given ID", + "description" : "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.", + "operationId" : "deleteVersionControlRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/process-groups/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the Version Control information for a process group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVersionInformation", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "versions" ], + "summary" : "Save the Process Group with the given ID", + "description" : "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.", + "operationId" : "saveToFlowRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/StartVersionControlRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "versions" ], + "summary" : "Update the version of a Process Group with the given ID", + "description" : "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.", + "operationId" : "updateFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Stops version controlling the Process Group with the given ID", + "description" : "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.", + "operationId" : "stopVersionControl", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/revert-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Revert Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateRevertFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/revert-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Revert Request with the given ID", + "description" : "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.", + "operationId" : "getRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Revert Request with the given ID", + "description" : "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.", + "operationId" : "deleteRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/update-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Update Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateVersionControlUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/update-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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.", + "operationId" : "getUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + } + }, + "definitions" : { + "AboutDTO" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "The title to be used on the page and in the about dialog." + }, + "version" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "uri" : { + "type" : "string", + "description" : "The URI for the NiFi." + }, + "contentViewerUrl" : { + "type" : "string", + "description" : "The URL for the content viewer if configured." + }, + "timezone" : { + "type" : "string", + "description" : "The timezone of the NiFi instance.", + "readOnly" : true + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "description" : "Build timestamp" + } + } + }, + "AboutEntity" : { + "type" : "object", + "properties" : { + "about" : { + "$ref" : "#/definitions/AboutDTO" + } + }, + "xml" : { + "name" : "aboutEntity" + } + }, + "AccessConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsLogin" : { + "type" : "boolean", + "description" : "Indicates whether or not this NiFi supports user login.", + "readOnly" : true + } + } + }, + "AccessConfigurationEntity" : { + "type" : "object", + "properties" : { + "config" : { + "$ref" : "#/definitions/AccessConfigurationDTO" + } + }, + "xml" : { + "name" : "accessConfigurationEntity" + } + }, + "AccessPolicyDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + } + }, + "AccessPolicyEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicyDTO" + } + }, + "xml" : { + "name" : "accessPolicyEntity" + } + }, + "AccessPolicySummaryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + } + } + }, + "AccessPolicySummaryEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicySummaryDTO" + } + }, + "xml" : { + "name" : "accessPolicySummaryEntity" + } + }, + "AccessStatusDTO" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The user access status.", + "readOnly" : true + }, + "message" : { + "type" : "string", + "description" : "Additional details about the user access status.", + "readOnly" : true + } + }, + "xml" : { + "name" : "accessStatus" + } + }, + "AccessStatusEntity" : { + "type" : "object", + "properties" : { + "accessStatus" : { + "$ref" : "#/definitions/AccessStatusDTO" + } + }, + "xml" : { + "name" : "accessStatusEntity" + } + }, + "ActionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32", + "description" : "The action id." + }, + "userIdentity" : { + "type" : "string", + "description" : "The identity of the user that performed the action." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of the source component." + }, + "componentDetails" : { + "description" : "The details of the source component.", + "$ref" : "#/definitions/ComponentDetailsDTO" + }, + "operation" : { + "type" : "string", + "description" : "The operation that was performed." + }, + "actionDetails" : { + "description" : "The details of the action.", + "$ref" : "#/definitions/ActionDetailsDTO" + } + } + }, + "ActionDetailsDTO" : { + "type" : "object" + }, + "ActionEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "action" : { + "$ref" : "#/definitions/ActionDTO" + } + }, + "xml" : { + "name" : "actionEntity" + } + }, + "ActivateControllerServicesEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "activateControllerServicesEntity" + } + }, + "AffectedComponentDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + } + } + }, + "AffectedComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AffectedComponentDTO" + }, + "processGroup" : { + "description" : "The Process Group that the component belongs to", + "$ref" : "#/definitions/ProcessGroupNameDTO" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of component referenced", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + } + }, + "xml" : { + "name" : "affectedComponentEntity" + } + }, + "AllowableValueDTO" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "A human readable value that is allowed for the property descriptor." + }, + "value" : { + "type" : "string", + "description" : "A value that is allowed for the property descriptor." + }, + "description" : { + "type" : "string", + "description" : "A description for this allowable value." + } + } + }, + "AllowableValueEntity" : { + "type" : "object", + "properties" : { + "allowableValue" : { + "$ref" : "#/definitions/AllowableValueDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "AttributeDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The attribute name." + }, + "value" : { + "type" : "string", + "description" : "The attribute value." + }, + "previousValue" : { + "type" : "string", + "description" : "The value of the attribute before the event took place." + } + } + }, + "BannerDTO" : { + "type" : "object", + "properties" : { + "headerText" : { + "type" : "string", + "description" : "The header text." + }, + "footerText" : { + "type" : "string", + "description" : "The footer text." + } + } + }, + "BannerEntity" : { + "type" : "object", + "properties" : { + "banners" : { + "$ref" : "#/definitions/BannerDTO" + } + }, + "xml" : { + "name" : "bannersEntity" + } + }, + "BatchSettingsDTO" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "Bucket" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket." + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "readOnly" : true, + "minimum" : 1 + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "allowBundleRedeploy" : { + "type" : "boolean", + "description" : "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." + }, + "allowPublicRead" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" + }, + "permissions" : { + "description" : "The access that the current user has to this bucket.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "BucketDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The bucket identifier" + }, + "name" : { + "type" : "string", + "description" : "The bucket name" + }, + "description" : { + "type" : "string", + "description" : "The bucket description" + }, + "created" : { + "type" : "integer", + "format" : "int64", + "description" : "The created timestamp of this bucket" + } + } + }, + "BucketEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "bucket" : { + "$ref" : "#/definitions/BucketDTO" + }, + "permissions" : { + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "bucketEntity" + } + }, + "BucketsEntity" : { + "type" : "object", + "properties" : { + "buckets" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BucketEntity" + } + } + }, + "xml" : { + "name" : "bucketsEntity" + } + }, + "BulletinBoardDTO" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins in the bulletin board, that matches the supplied request.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp when this report was generated." + } + } + }, + "BulletinBoardEntity" : { + "type" : "object", + "properties" : { + "bulletinBoard" : { + "$ref" : "#/definitions/BulletinBoardDTO" + } + }, + "xml" : { + "name" : "bulletinBoardEntity" + } + }, + "BulletinDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "description" : "The id of the bulletin." + }, + "nodeAddress" : { + "type" : "string", + "description" : "If clustered, the address of the node from which the bulletin originated." + }, + "category" : { + "type" : "string", + "description" : "The category of this bulletin." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the source component." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "level" : { + "type" : "string", + "description" : "The level of the bulletin." + }, + "message" : { + "type" : "string", + "description" : "The bulletin message." + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + } + } + }, + "BulletinEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "groupId" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + }, + "nodeAddress" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "bulletin" : { + "$ref" : "#/definitions/BulletinDTO" + } + }, + "xml" : { + "name" : "bulletinEntity" + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleDTO" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle." + } + } + }, + "ClusteSummaryEntity" : { + "type" : "object", + "properties" : { + "clusterSummary" : { + "$ref" : "#/definitions/ClusterSummaryDTO" + } + }, + "xml" : { + "name" : "clusterSummaryEntity" + } + }, + "ClusterDTO" : { + "type" : "object", + "properties" : { + "nodes" : { + "type" : "array", + "description" : "The collection of nodes that are part of the cluster.", + "items" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp the report was generated." + } + } + }, + "ClusterEntity" : { + "type" : "object", + "properties" : { + "cluster" : { + "$ref" : "#/definitions/ClusterDTO" + } + }, + "xml" : { + "name" : "clusterEntity" + } + }, + "ClusterSearchResultsEntity" : { + "type" : "object", + "properties" : { + "nodeResults" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NodeSearchResultDTO" + } + } + }, + "xml" : { + "name" : "clusterSearchResultsEntity" + } + }, + "ClusterSummaryDTO" : { + "type" : "object", + "properties" : { + "connectedNodes" : { + "type" : "string", + "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." + }, + "connectedNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes that are currently connected to the cluster" + }, + "totalNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" + }, + "clustered" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is clustered." + }, + "connectedToCluster" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is connected to a cluster." + } + } + }, + "ComponentDetailsDTO" : { + "type" : "object" + }, + "ComponentDifferenceDTO" : { + "type" : "object", + "properties" : { + "componentType" : { + "type" : "string", + "description" : "The type of component" + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the component belongs to" + }, + "differences" : { + "type" : "array", + "description" : "The differences in the component between the two flows", + "items" : { + "$ref" : "#/definitions/DifferenceDTO" + } + } + } + }, + "ComponentHistoryDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component id." + }, + "propertyHistory" : { + "type" : "object", + "description" : "The history for the properties of the component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyHistoryDTO" + } + } + } + }, + "ComponentHistoryEntity" : { + "type" : "object", + "properties" : { + "componentHistory" : { + "$ref" : "#/definitions/ComponentHistoryDTO" + } + }, + "xml" : { + "name" : "componentHistoryEntity" + } + }, + "ComponentReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component." + } + } + }, + "ComponentReferenceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "component" : { + "$ref" : "#/definitions/ComponentReferenceDTO" + } + }, + "xml" : { + "name" : "componentReferenceEntity" + } + }, + "ComponentRestrictionPermissionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "permissions" : { + "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + } + } + }, + "ComponentSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component that matched the search." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the component that matched the search." + }, + "parentGroup" : { + "description" : "The parent group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "versionedGroup" : { + "description" : "The nearest versioned ancestor group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component that matched the search." + }, + "matches" : { + "type" : "array", + "description" : "What matched the search from the component.", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentStateDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component identifier." + }, + "stateDescription" : { + "type" : "string", + "description" : "Description of the state this component persists." + }, + "clusterState" : { + "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", + "$ref" : "#/definitions/StateMapDTO" + }, + "localState" : { + "description" : "The local state for this component.", + "$ref" : "#/definitions/StateMapDTO" + } + } + }, + "ComponentStateEntity" : { + "type" : "object", + "properties" : { + "componentState" : { + "description" : "The component state.", + "$ref" : "#/definitions/ComponentStateDTO" + } + }, + "xml" : { + "name" : "componentStateEntity" + } + }, + "ComponentValidationResultDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "currentlyValid" : { + "type" : "boolean", + "description" : "Whether or not the component is currently valid" + }, + "resultsValid" : { + "type" : "boolean", + "description" : "Whether or not the component will be valid if the Parameter Context is changed" + }, + "resultantValidationErrors" : { + "type" : "array", + "description" : "The validation errors that will apply to the component if the Parameter Context is changed", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentValidationResultEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ComponentValidationResultDTO" + } + }, + "xml" : { + "name" : "componentValidationResultEntity" + } + }, + "ComponentValidationResultsEntity" : { + "type" : "object", + "properties" : { + "validationResults" : { + "type" : "array", + "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", + "items" : { + "$ref" : "#/definitions/ComponentValidationResultEntity" + } + } + }, + "xml" : { + "name" : "componentValidationResults" + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectableDTO" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "running" : { + "type" : "boolean", + "description" : "Reflects the current state of the connectable component." + }, + "transmitting" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." + }, + "exists" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target exists." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "availableRelationships" : { + "type" : "array", + "description" : "The relationships that the source of the connection currently supports.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "How to load balance the data in this Connection across the nodes in the cluster.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "loadBalancePartitionAttribute" : { + "type" : "string", + "description" : "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" + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "loadBalanceStatus" : { + "type" : "string", + "description" : "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.", + "readOnly" : true, + "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] + } + } + }, + "ConnectionEntity" : { + "type" : "object", + "required" : [ "destinationType", "sourceType" ], + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ConnectionDTO" + }, + "status" : { + "description" : "The status of the connection.", + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The identifier of the source of this connection." + }, + "sourceGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the source of this connection." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of component the source connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "destinationId" : { + "type" : "string", + "description" : "The identifier of the destination of this connection." + }, + "destinationGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the destination of this connection." + }, + "destinationType" : { + "type" : "string", + "description" : "The type of component the destination connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + } + }, + "xml" : { + "name" : "connectionEntity" + } + }, + "ConnectionStatisticsDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" + } + } + } + }, + "ConnectionStatisticsEntity" : { + "type" : "object", + "properties" : { + "connectionStatistics" : { + "$ref" : "#/definitions/ConnectionStatisticsDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatisticsEntity" + } + }, + "ConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of queued objects at the next configured interval." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." + }, + "predictionIntervalMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The prediction interval in seconds" + } + } + }, + "ConnectionStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the connection belongs to" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "sourceId" : { + "type" : "string", + "description" : "The ID of the source component" + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component" + }, + "destinationId" : { + "type" : "string", + "description" : "The ID of the destination component" + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination component" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" + } + } + } + }, + "ConnectionStatusEntity" : { + "type" : "object", + "properties" : { + "connectionStatus" : { + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatusEntity" + } + }, + "ConnectionStatusPredictionsSnapshotDTO" : { + "type" : "object", + "properties" : { + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictionIntervalSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the process group the connection belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source of the connection." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source of the connection." + }, + "destinationId" : { + "type" : "string", + "description" : "The id of the destination of the connection." + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination of the connection." + }, + "predictions" : { + "description" : "Predictions, if available, for this connection (null if not available)", + "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have left the connection in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are currently queued in the connection." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that are currently queued in the connection." + }, + "queued" : { + "type" : "string", + "description" : "The total count and size of queued flowfiles formatted." + }, + "queuedSize" : { + "type" : "string", + "description" : "The total size of flowfiles that are queued formatted." + }, + "queuedCount" : { + "type" : "string", + "description" : "The number of flowfiles that are queued, pretty printed." + }, + "percentUseCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "percentUseBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "connectionStatusSnapshot" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ConnectionsEntity" : { + "type" : "object", + "properties" : { + "connections" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } + }, + "xml" : { + "name" : "connectionsEntity" + } + }, + "ControllerBulletinsEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "System level bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "controllerServiceBulletins" : { + "type" : "array", + "description" : "Controller service bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "reportingTaskBulletins" : { + "type" : "array", + "description" : "Reporting task bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerConfigurationDTO" : { + "type" : "object", + "properties" : { + "maxTimerDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of timer driven threads the NiFi has available." + }, + "maxEventDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of event driven threads the NiFi has available." + } + } + }, + "ControllerConfigurationEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/ControllerConfigurationDTO" + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the NiFi." + }, + "name" : { + "type" : "string", + "description" : "The name of the NiFi." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the NiFi." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports contained in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports contained in the NiFi." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports contained in the NiFi." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the NiFi." + }, + "remoteSiteListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "remoteSiteHttpListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "siteToSiteSecure" : { + "type" : "boolean", + "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." + }, + "instanceId" : { + "type" : "string", + "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports available to send data to for the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports available to received data from the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + } + } + }, + "ControllerEntity" : { + "type" : "object", + "properties" : { + "controller" : { + "$ref" : "#/definitions/ControllerDTO" + } + }, + "xml" : { + "name" : "controllerEntity" + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceApiDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "ControllerServiceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the controller service." + }, + "state" : { + "type" : "string", + "description" : "The state of the controller service.", + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the controller service persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the controller service requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the ontroller service has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the controller service has multiple versions available." + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the controller service properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the controller services custom configuration UI if applicable." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "referencingComponents" : { + "type" : "array", + "description" : "All components referencing this controller service.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ControllerServiceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this ControllerService." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ControllerService.", + "readOnly" : true, + "$ref" : "#/definitions/ControllerServiceStatusDTO" + } + }, + "xml" : { + "name" : "controllerServiceEntity" + } + }, + "ControllerServiceReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "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." + }, + "id" : { + "type" : "string", + "description" : "The id of the component referencing a controller service." + }, + "name" : { + "type" : "string", + "description" : "The name of the component referencing a controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the component referencing a controller service in simple Java class name format without package name." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the component properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "referenceType" : { + "type" : "string", + "description" : "The type of reference this is.", + "enum" : [ "Processor", "ControllerService", "ReportingTask" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "referenceCycle" : { + "type" : "boolean", + "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." + }, + "referencingComponents" : { + "type" : "array", + "description" : "If the referencing component represents a controller service, these are the components that reference it.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + } + }, + "ControllerServiceReferencingComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentEntity" + } + }, + "ControllerServiceReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "controllerServiceReferencingComponents" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentsEntity" + } + }, + "ControllerServiceRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ControllerService.", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ControllerServiceStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ControllerService", + "readOnly" : true, + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ControllerServiceTypesEntity" : { + "type" : "object", + "properties" : { + "controllerServiceTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "controllerServiceTypesEntity" + } + }, + "ControllerServicesEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "controllerServices" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } + }, + "xml" : { + "name" : "controllerServicesEntity" + } + }, + "ControllerStatusDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads in the NiFi." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of terminated threads in the NiFi." + }, + "queued" : { + "type" : "string", + "description" : "The number of flowfiles queued in the NiFi." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles queued across the entire flow" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles queued across the entire flow" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the NiFi." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the NiFi." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the NiFi." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the NiFi." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the NiFi." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." + } + } + }, + "ControllerStatusEntity" : { + "type" : "object", + "properties" : { + "controllerStatus" : { + "$ref" : "#/definitions/ControllerStatusDTO" + } + }, + "xml" : { + "name" : "controllerStatusEntity" + } + }, + "CopySnippetRequestEntity" : { + "type" : "object", + "properties" : { + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "CounterDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the counter." + }, + "context" : { + "type" : "string", + "description" : "The context of the counter." + }, + "name" : { + "type" : "string", + "description" : "The name of the counter." + }, + "valueCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The value count." + }, + "value" : { + "type" : "string", + "description" : "The value of the counter." + } + } + }, + "CounterEntity" : { + "type" : "object", + "properties" : { + "counter" : { + "$ref" : "#/definitions/CounterDTO" + } + }, + "xml" : { + "name" : "counterEntity" + } + }, + "CountersDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/CountersSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeCountersSnapshotDTO" + } + } + } + }, + "CountersEntity" : { + "type" : "object", + "properties" : { + "counters" : { + "$ref" : "#/definitions/CountersDTO" + } + }, + "xml" : { + "name" : "countersEntity" + } + }, + "CountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "counters" : { + "type" : "array", + "description" : "All counters in the NiFi.", + "items" : { + "$ref" : "#/definitions/CounterDTO" + } + } + } + }, + "CreateActiveRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The Process Group ID that this active request will update" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createActiveRequestEntity" + } + }, + "CreateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createTemplateRequestEntity" + } + }, + "CurrentUserEntity" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity being serialized." + }, + "anonymous" : { + "type" : "boolean", + "description" : "Whether the current user is anonymous." + }, + "provenancePermissions" : { + "description" : "Permissions for querying provenance.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "countersPermissions" : { + "description" : "Permissions for accessing counters.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "tenantsPermissions" : { + "description" : "Permissions for accessing tenants.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "controllerPermissions" : { + "description" : "Permissions for accessing the controller.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "policiesPermissions" : { + "description" : "Permissions for accessing the policies.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "systemPermissions" : { + "description" : "Permissions for accessing system.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "parameterContextPermissions" : { + "description" : "Permissions for accessing parameter contexts.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "restrictedComponentsPermissions" : { + "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "componentRestrictionPermissions" : { + "type" : "array", + "description" : "Permissions for specific component restrictions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" + } + }, + "canVersionFlows" : { + "type" : "boolean", + "description" : "Whether the current user can version flows." + } + }, + "xml" : { + "name" : "currentEntity" + } + }, + "DifferenceDTO" : { + "type" : "object", + "properties" : { + "differenceType" : { + "type" : "string", + "description" : "The type of difference" + }, + "difference" : { + "type" : "string", + "description" : "Description of the difference" + } + } + }, + "DimensionsDTO" : { + "type" : "object", + "properties" : { + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + } + } + }, + "DocumentedTypeDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the type." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "If this type represents a ControllerService, this lists the APIs it implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the type." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether this type is restricted." + }, + "usageRestriction" : { + "type" : "string", + "description" : "The optional description of why the usage of this component is restricted." + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExplicitRestrictionDTO" + } + }, + "deprecationReason" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted." + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "DropRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this drop request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this drop request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this drop request failed." + }, + "currentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files currently queued." + }, + "currentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files currently queued in bytes." + }, + "current" : { + "type" : "string", + "description" : "The count and size of flow files currently queued." + }, + "originalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files to be dropped as a result of this request." + }, + "originalSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files to be dropped as a result of this request in bytes." + }, + "original" : { + "type" : "string", + "description" : "The count and size of flow files to be dropped as a result of this request." + }, + "droppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files that have been dropped thus far." + }, + "droppedSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files that have been dropped thus far in bytes." + }, + "dropped" : { + "type" : "string", + "description" : "The count and size of flow files that have been dropped thus far." + }, + "state" : { + "type" : "string", + "description" : "The current state of the drop request." + } + } + }, + "DropRequestEntity" : { + "type" : "object", + "properties" : { + "dropRequest" : { + "$ref" : "#/definitions/DropRequestDTO" + } + }, + "xml" : { + "name" : "dropRequestEntity" + } + }, + "ExplicitRestrictionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "explanation" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted for this required permission." + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "FlowBreadcrumbDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The id of the group." + }, + "versionControlInformation" : { + "description" : "The process group version control information or null if not version controlled.", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "FlowBreadcrumbEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this ancestor ProcessGroup." + }, + "permissions" : { + "description" : "The permissions for this ancestor ProcessGroup.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "breadcrumb" : { + "description" : "This breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbDTO" + }, + "parentBreadcrumb" : { + "description" : "The parent breadcrumb for this breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowComparisonEntity" : { + "type" : "object", + "properties" : { + "componentDifferences" : { + "type" : "array", + "description" : "The list of differences for each component in the flow that is not the same between the two flows", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceDTO" + } + } + }, + "xml" : { + "name" : "flowComparisonEntity" + } + }, + "FlowConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi supports configurable users and groups.", + "readOnly" : true + }, + "autoRefreshIntervalSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "The interval in seconds between the automatic NiFi refresh requests.", + "readOnly" : true + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the system." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The default back pressure object threshold." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The default back pressure data size threshold." + } + } + }, + "FlowConfigurationEntity" : { + "type" : "object", + "properties" : { + "flowConfiguration" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/FlowConfigurationDTO" + } + }, + "xml" : { + "name" : "flowConfigurationEntity" + } + }, + "FlowDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + } + }, + "FlowEntity" : { + "type" : "object", + "properties" : { + "flow" : { + "$ref" : "#/definitions/FlowDTO" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowFileDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "attributes" : { + "type" : "object", + "description" : "The FlowFile attributes.", + "additionalProperties" : { + "type" : "string" + } + }, + "contentClaimSection" : { + "type" : "string", + "description" : "The section in which the content claim lives." + }, + "contentClaimContainer" : { + "type" : "string", + "description" : "The container in which the content claim lives." + }, + "contentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the content claim." + }, + "contentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the content claim where the flowfile's content begins." + }, + "contentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the content claim formatted." + }, + "contentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the content claim in bytes." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowFileEntity" : { + "type" : "object", + "properties" : { + "flowFile" : { + "$ref" : "#/definitions/FlowFileDTO" + } + }, + "xml" : { + "name" : "flowFileEntity" + } + }, + "FlowFileSummaryDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowSnippetDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupDTO" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorDTO" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDTO" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The controller services in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceDTO" + } + } + } + }, + "FunnelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + } + } + }, + "FunnelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "xml" : { + "name" : "funnelEntity" + } + }, + "FunnelsEntity" : { + "type" : "object", + "properties" : { + "funnels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + }, + "xml" : { + "name" : "funnelsEntity" + } + }, + "GarbageCollectionDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the garbage collector." + }, + "collectionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of times garbage collection has run." + }, + "collectionTime" : { + "type" : "string", + "description" : "The total amount of time spent garbage collecting." + }, + "collectionMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of milliseconds spent garbage collecting." + } + } + }, + "HistoryDTO" : { + "type" : "object", + "properties" : { + "total" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of number of actions that matched the search criteria.." + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "actions" : { + "type" : "array", + "description" : "The actions.", + "items" : { + "$ref" : "#/definitions/ActionEntity" + } + } + } + }, + "HistoryEntity" : { + "type" : "object", + "properties" : { + "history" : { + "$ref" : "#/definitions/HistoryDTO" + } + }, + "xml" : { + "name" : "historyEntity" + } + }, + "InputPortsEntity" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "inputPortsEntity" + } + }, + "InstantiateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "templateId" : { + "type" : "string", + "description" : "The identifier of the template." + }, + "encodingVersion" : { + "type" : "string", + "description" : "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." + }, + "snippet" : { + "description" : "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.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "instantiateTemplateRequestEntity" + } + }, + "JaxbLink" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "format" : "uri", + "xml" : { + "attribute" : true + }, + "description" : "The href for the link" + }, + "params" : { + "type" : "object", + "description" : "The params for the link", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "dimensions" : { + "$ref" : "#/definitions/DimensionsDTO" + }, + "component" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "xml" : { + "name" : "labelEntity" + } + }, + "LabelsEntity" : { + "type" : "object", + "properties" : { + "labels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + } + }, + "xml" : { + "name" : "labelsEntity" + } + }, + "LineageDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this lineage query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this lineage query for later retrieval and deletion." + }, + "submissionTime" : { + "type" : "string", + "description" : "When the lineage query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "When the lineage query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percent complete for the lineage query." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the lineage query has finished." + }, + "request" : { + "description" : "The initial lineage result.", + "$ref" : "#/definitions/LineageRequestDTO" + }, + "results" : { + "description" : "The results of the lineage query.", + "$ref" : "#/definitions/LineageResultsDTO" + } + } + }, + "LineageEntity" : { + "type" : "object", + "properties" : { + "lineage" : { + "$ref" : "#/definitions/LineageDTO" + } + }, + "xml" : { + "name" : "lineageEntity" + } + }, + "LineageRequestDTO" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lineageRequestType" : { + "type" : "string", + "description" : "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.", + "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] + }, + "uuid" : { + "type" : "string", + "description" : "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." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this lineage originated if clustered." + } + } + }, + "LineageResultsDTO" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while generating the lineage.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "nodes" : { + "type" : "array", + "description" : "The nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceNodeDTO" + } + }, + "links" : { + "type" : "array", + "description" : "The links between the nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceLinkDTO" + } + } + } + }, + "ListingRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this listing request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this listing request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this listing request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this listing request failed." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of FlowFileSummary objects to return" + }, + "state" : { + "type" : "string", + "description" : "The current state of the listing request." + }, + "queueSize" : { + "description" : "The size of the queue", + "$ref" : "#/definitions/QueueSizeDTO" + }, + "flowFileSummaries" : { + "type" : "array", + "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", + "items" : { + "$ref" : "#/definitions/FlowFileSummaryDTO" + } + }, + "sourceRunning" : { + "type" : "boolean", + "description" : "Whether the source of the connection is running" + }, + "destinationRunning" : { + "type" : "boolean", + "description" : "Whether the destination of the connection is running" + } + } + }, + "ListingRequestEntity" : { + "type" : "object", + "properties" : { + "listingRequest" : { + "$ref" : "#/definitions/ListingRequestDTO" + } + }, + "xml" : { + "name" : "listingRequestEntity" + } + }, + "NodeConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statisticsSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + } + } + }, + "NodeConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + } + } + }, + "NodeCountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The counters from the node.", + "$ref" : "#/definitions/CountersSnapshotDTO" + } + } + }, + "NodeDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node.", + "readOnly" : true + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address.", + "readOnly" : true + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The node's status." + }, + "heartbeat" : { + "type" : "string", + "description" : "the time of the nodes's last heartbeat.", + "readOnly" : true + }, + "connectionRequested" : { + "type" : "string", + "description" : "The time of the node's last connection request.", + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "The roles of this node.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active threads for the NiFi on the node.", + "readOnly" : true + }, + "queued" : { + "type" : "string", + "description" : "The queue the NiFi on the node.", + "readOnly" : true + }, + "events" : { + "type" : "array", + "description" : "The node's events.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/NodeEventDTO" + } + }, + "nodeStartTime" : { + "type" : "string", + "description" : "The time at which this Node was last refreshed.", + "readOnly" : true + } + } + }, + "NodeEntity" : { + "type" : "object", + "properties" : { + "node" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "xml" : { + "name" : "nodeEntity" + } + }, + "NodeEventDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node event." + }, + "category" : { + "type" : "string", + "description" : "The category of the node event." + }, + "message" : { + "type" : "string", + "description" : "The message in the node event." + } + } + }, + "NodePortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The port status snapshot from the node.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + } + } + }, + "NodeProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The process group status snapshot from the node.", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The processor status snapshot from the node.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + } + } + }, + "NodeRemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The remote process group status snapshot from the node.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node that matched the search." + }, + "address" : { + "type" : "string", + "description" : "The address of the node that matched the search." + } + } + }, + "NodeStatusSnapshotsDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node." + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address." + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests." + }, + "statusSnapshots" : { + "type" : "array", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + } + } + }, + "NodeSystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The System Diagnostics snapshot from the node.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + } + } + }, + "OutputPortsEntity" : { + "type" : "object", + "properties" : { + "outputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "outputPortsEntity" + } + }, + "ParameterContextDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The Name of the Parameter Context." + }, + "description" : { + "type" : "string", + "description" : "The Description of the Parameter Context." + }, + "parameters" : { + "type" : "array", + "description" : "The Parameters for the Parameter Context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterEntity" + } + }, + "boundProcessGroups" : { + "type" : "array", + "description" : "The Process Groups that are bound to this Parameter Context", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "id" : { + "type" : "string", + "description" : "The ID the Parameter Context.", + "readOnly" : true + } + } + }, + "ParameterContextEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The Parameter Context", + "$ref" : "#/definitions/ParameterContextDTO" + } + }, + "xml" : { + "name" : "parameterContextEntity" + } + }, + "ParameterContextReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Parameter Context" + }, + "name" : { + "type" : "string", + "description" : "The name of the Parameter Context" + } + } + }, + "ParameterContextReferenceEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "component" : { + "$ref" : "#/definitions/ParameterContextReferenceDTO" + } + }, + "xml" : { + "name" : "parameterContextReferenceEntity" + } + }, + "ParameterContextUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextUpdateStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "$ref" : "#/definitions/ParameterContextDTO" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterContextUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "parameterContextRevision" : { + "description" : "The Revision of the Parameter Context", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" + } + }, + "xml" : { + "name" : "parameterContextUpdateRequestEntity" + } + }, + "ParameterContextUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextValidationRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextValidationStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on.", + "$ref" : "#/definitions/ParameterContextDTO" + }, + "componentValidationResults" : { + "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", + "readOnly" : true, + "$ref" : "#/definitions/ComponentValidationResultsEntity" + } + } + }, + "ParameterContextValidationRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextValidationRequestDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "parameterContextValidationRequestEntity" + } + }, + "ParameterContextValidationStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextsEntity" : { + "type" : "object", + "properties" : { + "parameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system.", + "readOnly" : true + } + }, + "xml" : { + "name" : "parameterContexts" + } + }, + "ParameterDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the Parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the Parameter" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the Parameter" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing this Parameter", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterEntity" : { + "type" : "object", + "properties" : { + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "parameter" : { + "description" : "The parameter information", + "$ref" : "#/definitions/ParameterDTO" + } + }, + "xml" : { + "name" : "parameterEntity" + } + }, + "PeerDTO" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "The hostname of this peer." + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "The port number of this peer." + }, + "secure" : { + "type" : "boolean", + "description" : "Returns if this peer connection is secure." + }, + "flowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flowFiles this peer holds." + } + } + }, + "PeersEntity" : { + "type" : "object", + "properties" : { + "peers" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PeerDTO" + } + } + }, + "xml" : { + "name" : "peersEntity" + } + }, + "Permissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + } + } + }, + "PermissionsDTO" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + } + }, + "PortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the port." + }, + "state" : { + "type" : "string", + "description" : "The state of the port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "transmitting" : { + "type" : "boolean", + "description" : "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." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "userAccessControl" : { + "type" : "array", + "description" : "The users that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "groupAccessControl" : { + "type" : "array", + "description" : "The user groups that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + } + } + }, + "PortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/PortDTO" + }, + "status" : { + "description" : "The status of the port.", + "$ref" : "#/definitions/PortStatusDTO" + }, + "portType" : { + "type" : "string" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + } + }, + "xml" : { + "name" : "portEntity" + } + }, + "PortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "PortStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodePortStatusSnapshotDTO" + } + } + } + }, + "PortStatusEntity" : { + "type" : "object", + "properties" : { + "portStatus" : { + "$ref" : "#/definitions/PortStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "portStatusEntity" + } + }, + "PortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for the port." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been processed in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have been processed in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + } + } + }, + "PortStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "portStatusSnapshot" : { + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "PositionDTO" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "PreviousValueDTO" : { + "type" : "object", + "properties" : { + "previousValue" : { + "type" : "string", + "description" : "The previous value." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the value was modified." + }, + "userIdentity" : { + "type" : "string", + "description" : "The user who changed the previous value." + } + } + }, + "PrioritizerTypesEntity" : { + "type" : "object", + "properties" : { + "prioritizerTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "prioritizerTypesEntity" + } + }, + "ProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the process group." + }, + "variables" : { + "type" : "object", + "description" : "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.", + "readOnly" : true, + "additionalProperties" : { + "type" : "string" + } + }, + "versionControlInformation" : { + "description" : "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", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "parameterContext" : { + "description" : "The Parameter Context that this Process Group is bound to.", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "contents" : { + "description" : "The contents of this process group.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + } + }, + "ProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessGroupDTO" + }, + "status" : { + "description" : "The status of the process group.", + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "versionedFlowSnapshot" : { + "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupEntity" + } + }, + "ProcessGroupFlowDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "breadcrumb" : { + "description" : "The breadcrumb of the process group.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + }, + "flow" : { + "description" : "The flow structure starting at this Process Group.", + "$ref" : "#/definitions/FlowDTO" + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The time the flow for the process group was last refreshed." + } + } + }, + "ProcessGroupFlowEntity" : { + "type" : "object", + "properties" : { + "permissions" : { + "description" : "The access policy for this process group.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "processGroupFlow" : { + "$ref" : "#/definitions/ProcessGroupFlowDTO" + } + }, + "xml" : { + "name" : "processGroupFlowEntity" + } + }, + "ProcessGroupNameDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" + } + } + }, + "ProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "The aggregate status of all nodes in the cluster", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" + } + } + } + }, + "ProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "processGroupStatus" : { + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupStatusEntity" + } + }, + "ProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "name" : { + "type" : "string", + "description" : "The name of this process group." + }, + "connectionStatusSnapshots" : { + "type" : "array", + "description" : "The status of all connections in the process group.", + "items" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" + } + }, + "processorStatusSnapshots" : { + "type" : "array", + "description" : "The status of all processors in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" + } + }, + "processGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all process groups in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" + } + }, + "remoteProcessGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all remote process groups in the process group.", + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" + } + }, + "inputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all input ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "outputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all output ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are queued up in this ProcessGroup right now" + }, + "queued" : { + "type" : "string", + "description" : "The count/size that is queued in the the process group." + }, + "queuedCount" : { + "type" : "string", + "description" : "The count that is queued for the process group." + }, + "queuedSize" : { + "type" : "string", + "description" : "The size that is queued for the process group." + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The output count/size for the process group in the last 5 minutes." + }, + "flowFilesTransferred" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" + }, + "bytesTransferred" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" + }, + "transferred" : { + "type" : "string", + "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "received" : { + "type" : "string", + "description" : "The count/size sent to the process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "sent" : { + "type" : "string", + "description" : "The count/size sent from this process group in the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for this process group." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the process group." + } + } + }, + "ProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "processGroupStatusSnapshot" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "processGroupsEntity" + } + }, + "ProcessorConfigDTO" : { + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "Descriptors for the processor's properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the processor." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the processor's custom configuration UI if applicable." + }, + "lossTolerant" : { + "type" : "boolean", + "description" : "Whether the processor is loss tolerant." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "defaultConcurrentTasks" : { + "type" : "object", + "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "ProcessorDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the processor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the processor", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "style" : { + "type" : "object", + "description" : "Styles for the processor (background-color : #eee).", + "additionalProperties" : { + "type" : "string" + } + }, + "relationships" : { + "type" : "array", + "description" : "The available relationships that the processor currently supports.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/RelationshipDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the processor." + }, + "supportsParallelProcessing" : { + "type" : "boolean", + "description" : "Whether the processor supports parallel processing." + }, + "supportsEventDriven" : { + "type" : "boolean", + "description" : "Whether the processor supports event driven scheduling." + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether the processor supports batching. This makes the run duration settings available." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the processor persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the processor requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the processor has been deprecated." + }, + "executionNodeRestricted" : { + "type" : "boolean", + "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the processor has multiple versions available." + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "config" : { + "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", + "$ref" : "#/definitions/ProcessorConfigDTO" + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ProcessorEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessorDTO" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "status" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "processorEntity" + } + }, + "ProcessorRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Processor.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the Processor" + }, + "type" : { + "type" : "string", + "description" : "The type of the Processor" + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the Processor", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" + } + } + } + }, + "ProcessorStatusEntity" : { + "type" : "object", + "properties" : { + "processorStatus" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processorStatusEntity" + } + }, + "ProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group to which the processor belongs." + }, + "name" : { + "type" : "string", + "description" : "The name of the prcessor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "runStatus" : { + "type" : "string", + "description" : "The state of the processor.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute.", + "enum" : [ "ALL", "PRIMARY" ] + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by this Processor in the last 5 mintues" + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by this Processor in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "taskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of times this Processor has run in the last 5 minutes" + }, + "tasksDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" + }, + "tasks" : { + "type" : "string", + "description" : "The total number of task this connectable has completed over the last 5 minutes." + }, + "tasksDuration" : { + "type" : "string", + "description" : "The total duration of all tasks for this connectable over the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently executing in the processor." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the processor." + } + } + }, + "ProcessorStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "processorStatusSnapshot" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorTypesEntity" : { + "type" : "object", + "properties" : { + "processorTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "processorTypesEntity" + } + }, + "ProcessorsEntity" : { + "type" : "object", + "properties" : { + "processors" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } + }, + "xml" : { + "name" : "processorsEntity" + } + }, + "PropertyDescriptorDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name for the property." + }, + "displayName" : { + "type" : "string", + "description" : "The human readable name for the property." + }, + "description" : { + "type" : "string", + "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value for the property." + }, + "allowableValues" : { + "type" : "array", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "items" : { + "$ref" : "#/definitions/AllowableValueEntity" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether the property is required." + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether the property is sensitive and protected whenever stored or represented." + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether the property is dynamic (user-defined)." + }, + "supportsEl" : { + "type" : "boolean", + "description" : "Whether the property supports expression language." + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "Scope of the Expression Language evaluation for the property." + }, + "identifiesControllerService" : { + "type" : "string", + "description" : "If the property identifies a controller service this returns the fully qualified type." + }, + "identifiesControllerServiceBundle" : { + "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "PropertyDescriptorEntity" : { + "type" : "object", + "properties" : { + "propertyDescriptor" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "xml" : { + "name" : "propertyDescriptor" + } + }, + "PropertyHistoryDTO" : { + "type" : "object", + "properties" : { + "previousValues" : { + "type" : "array", + "description" : "Previous values for a given property.", + "items" : { + "$ref" : "#/definitions/PreviousValueDTO" + } + } + } + }, + "ProvenanceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the provenance query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "The timestamp when the query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "request" : { + "description" : "The provenance request.", + "$ref" : "#/definitions/ProvenanceRequestDTO" + }, + "results" : { + "description" : "The provenance results.", + "$ref" : "#/definitions/ProvenanceResultsDTO" + } + } + }, + "ProvenanceEntity" : { + "type" : "object", + "properties" : { + "provenance" : { + "$ref" : "#/definitions/ProvenanceDTO" + } + }, + "xml" : { + "name" : "provenanceEntity" + } + }, + "ProvenanceEventDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The event uuid." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id. This is a one up number thats unique per node." + }, + "eventTime" : { + "type" : "string", + "description" : "The timestamp of the event." + }, + "eventDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The event duration in milliseconds." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The duration since the lineage began, in milliseconds." + }, + "eventType" : { + "type" : "string", + "description" : "The type of the event." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile for the event." + }, + "fileSize" : { + "type" : "string", + "description" : "The size of the flowfile for the event." + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the flowfile in bytes for the event." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the event originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the event originated." + }, + "groupId" : { + "type" : "string", + "description" : "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." + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component that generated the event." + }, + "componentType" : { + "type" : "string", + "description" : "The type of the component that generated the event." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component that generated the event." + }, + "sourceSystemFlowFileId" : { + "type" : "string", + "description" : "The source system flowfile id." + }, + "alternateIdentifierUri" : { + "type" : "string", + "description" : "The alternate identifier uri for the fileflow for the event." + }, + "attributes" : { + "type" : "array", + "description" : "The attributes of the flowfile for the event.", + "items" : { + "$ref" : "#/definitions/AttributeDTO" + } + }, + "parentUuids" : { + "type" : "array", + "description" : "The parent uuids for the event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The child uuids for the event.", + "items" : { + "type" : "string" + } + }, + "transitUri" : { + "type" : "string", + "description" : "The source/destination system uri if the event was a RECEIVE/SEND." + }, + "relationship" : { + "type" : "string", + "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." + }, + "details" : { + "type" : "string", + "description" : "The event details." + }, + "contentEqual" : { + "type" : "boolean", + "description" : "Whether the input and output content claim is the same." + }, + "inputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the input content is still available." + }, + "inputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the input content claim lives." + }, + "inputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the input content claim lives." + }, + "inputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the input content claim." + }, + "inputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the input content claim where the flowfiles content begins." + }, + "inputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the input content claim formatted." + }, + "inputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the intput content claim in bytes." + }, + "outputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the output content is still available." + }, + "outputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the output content claim lives." + }, + "outputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the output content claim lives." + }, + "outputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the output content claim." + }, + "outputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the output content claim where the flowfiles content begins." + }, + "outputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the output content claim formatted." + }, + "outputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the output content claim in bytes." + }, + "replayAvailable" : { + "type" : "boolean", + "description" : "Whether or not replay is available." + }, + "replayExplanation" : { + "type" : "string", + "description" : "Explanation as to why replay is unavailable." + }, + "sourceConnectionIdentifier" : { + "type" : "string", + "description" : "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." + } + } + }, + "ProvenanceEventEntity" : { + "type" : "object", + "properties" : { + "provenanceEvent" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "xml" : { + "name" : "provenanceEventEntity" + } + }, + "ProvenanceLinkDTO" : { + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "The source node id of the link." + }, + "targetId" : { + "type" : "string", + "description" : "The target node id of the link." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The flowfile uuid that traversed the link." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the link (based on the destination)." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of this link in milliseconds." + } + } + }, + "ProvenanceNodeDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile associated with the provenance event." + }, + "parentUuids" : { + "type" : "array", + "description" : "The uuid of the parent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The uuid of the childrent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "clusterNodeIdentifier" : { + "type" : "string", + "description" : "The identifier of the node that this event/flowfile originated from." + }, + "type" : { + "type" : "string", + "description" : "The type of the node.", + "enum" : [ "FLOWFILE", "EVENT" ] + }, + "eventType" : { + "type" : "string", + "description" : "If the type is EVENT, this is the type of event." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the node in milliseconds." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node formatted." + } + } + }, + "ProvenanceOptionsDTO" : { + "type" : "object", + "properties" : { + "searchableFields" : { + "type" : "array", + "description" : "The available searchable field for the NiFi.", + "items" : { + "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" + } + } + } + }, + "ProvenanceOptionsEntity" : { + "type" : "object", + "properties" : { + "provenanceOptions" : { + "$ref" : "#/definitions/ProvenanceOptionsDTO" + } + }, + "xml" : { + "name" : "provenanceOptionsEntity" + } + }, + "ProvenanceRequestDTO" : { + "type" : "object", + "properties" : { + "searchTerms" : { + "type" : "object", + "description" : "The search terms used to perform the search.", + "additionalProperties" : { + "type" : "string" + } + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node in the cluster where this provenance originated." + }, + "startDate" : { + "type" : "string", + "description" : "The earliest event time to include in the query." + }, + "endDate" : { + "type" : "string", + "description" : "The latest event time to include in the query." + }, + "minimumFileSize" : { + "type" : "string", + "description" : "The minimum file size to include in the query." + }, + "maximumFileSize" : { + "type" : "string", + "description" : "The maximum file size to include in the query." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of results to include." + }, + "summarize" : { + "type" : "boolean", + "description" : "Whether or not to summarize provenance events returned. This property is false by default." + }, + "incrementalResults" : { + "type" : "boolean", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." + } + } + }, + "ProvenanceResultsDTO" : { + "type" : "object", + "properties" : { + "provenanceEvents" : { + "type" : "array", + "description" : "The provenance events that matched the search criteria.", + "items" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "total" : { + "type" : "string", + "description" : "The total number of results formatted." + }, + "totalCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of results." + }, + "generated" : { + "type" : "string", + "description" : "Then the search was performed." + }, + "oldestEvent" : { + "type" : "string", + "description" : "The oldest event available in the provenance repository." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the server that's used for event time." + }, + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while performing the provenance request.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ProvenanceSearchableFieldDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the searchable field." + }, + "field" : { + "type" : "string", + "description" : "The searchable field." + }, + "label" : { + "type" : "string", + "description" : "The label for the searchable field." + }, + "type" : { + "type" : "string", + "description" : "The type of the searchable field." + } + } + }, + "QueueSizeDTO" : { + "type" : "object", + "properties" : { + "byteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of objects in a queue." + }, + "objectCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The count of objects in a queue." + } + } + }, + "RegistryClientEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RegistryDTO" + } + }, + "xml" : { + "name" : "registryClientEntity" + } + }, + "RegistryClientsEntity" : { + "type" : "object", + "properties" : { + "registries" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } + }, + "xml" : { + "name" : "registryClientsEntity" + } + }, + "RegistryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The registry identifier" + }, + "name" : { + "type" : "string", + "description" : "The registry name" + }, + "description" : { + "type" : "string", + "description" : "The registry description" + }, + "uri" : { + "type" : "string", + "description" : "The registry URI" + } + } + }, + "RelationshipDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The relationship name." + }, + "description" : { + "type" : "string", + "description" : "The relationship description." + }, + "autoTerminate" : { + "type" : "boolean", + "description" : "Whether or not flowfiles sent to this relationship should auto terminate." + } + } + }, + "RemotePortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the RemotePort.", + "enum" : [ "TRANSMITTING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupContentsDTO" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "description" : "The input ports to which data can be sent.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports from which data can be retrieved.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + } + } + }, + "RemoteProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "targetUri" : { + "type" : "string", + "description" : "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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "targetSecure" : { + "type" : "boolean", + "description" : "Whether the target is running securely." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the remote process group." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string" + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "authorizationIssues" : { + "type" : "array", + "description" : "Any remote authorization issues for the remote process group.", + "items" : { + "type" : "string" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote process group is actively transmitting." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "activeRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote input ports." + }, + "inactiveRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote input ports." + }, + "activeRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote output ports." + }, + "inactiveRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote output ports." + }, + "flowRefreshed" : { + "type" : "string", + "description" : "The timestamp when this remote process group was last refreshed." + }, + "contents" : { + "description" : "The contents of the remote process group. Will contain available input/output ports.", + "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" + } + } + }, + "RemoteProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + }, + "status" : { + "description" : "The status of the remote process group.", + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupEntity" + } + }, + "RemoteProcessGroupPortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "targetId" : { + "type" : "string", + "description" : "The id of the target port." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the target port." + }, + "comments" : { + "type" : "string", + "description" : "The comments as configured on the target port." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote port is configured for transmission." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "exists" : { + "type" : "boolean", + "description" : "Whether the target port exists." + }, + "targetRunning" : { + "type" : "boolean", + "description" : "Whether the target port is running." + }, + "connected" : { + "type" : "boolean", + "description" : "Whether the port has either an incoming or outgoing connection." + }, + "batchSettings" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSettingsDTO" + } + } + }, + "RemoteProcessGroupPortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "remoteProcessGroupPort" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupPortEntity" + } + }, + "RemoteProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" + } + } + } + }, + "RemoteProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroupStatus" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "remoteProcessGroupStatusEntity" + } + }, + "RemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group the remote process group resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the remote process group." + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." + }, + "sent" : { + "type" : "string", + "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." + }, + "received" : { + "type" : "string", + "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." + } + } + }, + "RemoteProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "remoteProcessGroupStatusSnapshot" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "remoteProcessGroupsEntity" + } + }, + "ReportingTaskDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the reporting task." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the reporting task." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the reporting task.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "comments" : { + "type" : "string", + "description" : "The comments of the reporting task." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the reporting task persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the reporting task requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the reporting task has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the reporting task has multiple versions available." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "The default scheduling period for the different scheduling strategies.", + "additionalProperties" : { + "type" : "string" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the reporting task.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the reporting tasks properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the reporting task." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the reporting task." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ReportingTaskEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ReportingTaskDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ReportingTask.", + "readOnly" : true, + "$ref" : "#/definitions/ReportingTaskStatusDTO" + } + }, + "xml" : { + "name" : "reportingTaskEntity" + } + }, + "ReportingTaskRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ReportingTask.", + "enum" : [ "RUNNING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ReportingTaskStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ReportingTask", + "readOnly" : true, + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ReportingTaskTypesEntity" : { + "type" : "object", + "properties" : { + "reportingTaskTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "reportingTaskTypesEntity" + } + }, + "ReportingTasksEntity" : { + "type" : "object", + "properties" : { + "reportingTasks" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } + }, + "xml" : { + "name" : "reportingTasksEntity" + } + }, + "RequiredPermissionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The required sub-permission necessary for this restriction." + }, + "label" : { + "type" : "string", + "description" : "The label for the required sub-permission necessary for this restriction." + } + } + }, + "ResourceDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource." + }, + "name" : { + "type" : "string", + "description" : "The name of the resource." + } + } + }, + "ResourcesEntity" : { + "type" : "object", + "properties" : { + "resources" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ResourceDTO" + } + } + }, + "xml" : { + "name" : "resourcesEntity" + } + }, + "RevisionDTO" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "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" + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the flow.", + "readOnly" : true + } + } + }, + "ScheduleComponentsEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "scheduleComponentEntity" + } + }, + "SearchResultGroupDTO" : { + "type" : "object", + "required" : [ "id" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The name of the group." + } + } + }, + "SearchResultsDTO" : { + "type" : "object", + "properties" : { + "processorResults" : { + "type" : "array", + "description" : "The processors that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "connectionResults" : { + "type" : "array", + "description" : "The connections that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "processGroupResults" : { + "type" : "array", + "description" : "The process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "inputPortResults" : { + "type" : "array", + "description" : "The input ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "outputPortResults" : { + "type" : "array", + "description" : "The output ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "remoteProcessGroupResults" : { + "type" : "array", + "description" : "The remote process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "funnelResults" : { + "type" : "array", + "description" : "The funnels that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterContextResults" : { + "type" : "array", + "description" : "The parameter contexts that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterResults" : { + "type" : "array", + "description" : "The parameters that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + } + } + }, + "SearchResultsEntity" : { + "type" : "object", + "properties" : { + "searchResultsDTO" : { + "$ref" : "#/definitions/SearchResultsDTO" + } + }, + "xml" : { + "name" : "searchResultsEntity" + } + }, + "SnippetDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the snippet." + }, + "uri" : { + "type" : "string", + "description" : "The URI of the snippet." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The group id for the components in the snippet." + }, + "processGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "remoteProcessGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "processors" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "inputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "outputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "connections" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "labels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "funnels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + } + } + }, + "SnippetEntity" : { + "type" : "object", + "properties" : { + "snippet" : { + "description" : "The snippet.", + "$ref" : "#/definitions/SnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "snippetEntity" + } + }, + "StartVersionControlRequestEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "startVersionControlRequestEntity" + } + }, + "StateEntryDTO" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string", + "description" : "The key for this state." + }, + "value" : { + "type" : "string", + "description" : "The value for this state." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the state originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the state originated." + } + } + }, + "StateMapDTO" : { + "type" : "object", + "properties" : { + "scope" : { + "type" : "string", + "description" : "The scope of this StateMap." + }, + "totalEntryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." + }, + "state" : { + "type" : "array", + "description" : "The state.", + "items" : { + "$ref" : "#/definitions/StateEntryDTO" + } + } + } + }, + "StatusDescriptorDTO" : { + "type" : "object", + "properties" : { + "field" : { + "type" : "string", + "description" : "The name of the status field." + }, + "label" : { + "type" : "string", + "description" : "The label for the status field." + }, + "description" : { + "type" : "string", + "description" : "The description of the status field." + }, + "formatter" : { + "type" : "string", + "description" : "The formatter for the status descriptor." + } + } + }, + "StatusHistoryDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When the status history was generated." + }, + "componentDetails" : { + "type" : "object", + "description" : "A Map of key/value pairs that describe the component that the status history belongs to", + "additionalProperties" : { + "type" : "string" + } + }, + "fieldDescriptors" : { + "type" : "array", + "description" : "The Descriptors that provide information on each of the metrics provided in the status history", + "items" : { + "$ref" : "#/definitions/StatusDescriptorDTO" + } + }, + "aggregateSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeStatusSnapshotsDTO" + } + } + } + }, + "StatusHistoryEntity" : { + "type" : "object", + "properties" : { + "statusHistory" : { + "$ref" : "#/definitions/StatusHistoryDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "statusHistoryEntity" + } + }, + "StatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of the snapshot." + }, + "statusMetrics" : { + "type" : "object", + "description" : "The status metrics.", + "additionalProperties" : { + "type" : "integer", + "format" : "int64" + } + } + } + }, + "StorageUsageDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." + }, + "freeSpace" : { + "type" : "string", + "description" : "Amount of free space." + }, + "totalSpace" : { + "type" : "string", + "description" : "Amount of total space." + }, + "usedSpace" : { + "type" : "string", + "description" : "Amount of used space." + }, + "freeSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of free space." + }, + "totalSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of total space." + }, + "usedSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of used space." + }, + "utilization" : { + "type" : "string", + "description" : "Utilization of this storage location." + } + } + }, + "StreamingOutput" : { + "type" : "object" + }, + "SubmitReplayRequestEntity" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event identifier" + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier of the node where to submit the replay request." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "SystemDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" + } + } + } + }, + "SystemDiagnosticsEntity" : { + "type" : "object", + "properties" : { + "systemDiagnostics" : { + "$ref" : "#/definitions/SystemDiagnosticsDTO" + } + }, + "xml" : { + "name" : "systemDiagnosticsEntity" + } + }, + "SystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "totalNonHeap" : { + "type" : "string", + "description" : "Total size of non heap." + }, + "totalNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes allocated to the JVM not used for heap" + }, + "usedNonHeap" : { + "type" : "string", + "description" : "Amount of use non heap." + }, + "usedNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes used by the JVM not in the heap space" + }, + "freeNonHeap" : { + "type" : "string", + "description" : "Amount of free non heap." + }, + "freeNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of free non-heap bytes available to the JVM" + }, + "maxNonHeap" : { + "type" : "string", + "description" : "Maximum size of non heap." + }, + "maxNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" + }, + "nonHeapUtilization" : { + "type" : "string", + "description" : "Utilization of non heap." + }, + "totalHeap" : { + "type" : "string", + "description" : "Total size of heap." + }, + "totalHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of bytes that are available for the JVM heap to use" + }, + "usedHeap" : { + "type" : "string", + "description" : "Amount of used heap." + }, + "usedHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of JVM heap that are currently being used" + }, + "freeHeap" : { + "type" : "string", + "description" : "Amount of free heap." + }, + "freeHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" + }, + "maxHeap" : { + "type" : "string", + "description" : "Maximum size of heap." + }, + "maxHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that can be used by the JVM" + }, + "heapUtilization" : { + "type" : "string", + "description" : "Utilization of heap." + }, + "availableProcessors" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of available processors if supported by the underlying system." + }, + "processorLoadAverage" : { + "type" : "number", + "format" : "double", + "description" : "The processor load average if supported by the underlying system." + }, + "totalThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of threads." + }, + "daemonThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of daemon threads." + }, + "uptime" : { + "type" : "string", + "description" : "The uptime of the Java virtual machine" + }, + "flowFileRepositoryStorageUsage" : { + "description" : "The flowfile repository storage usage.", + "$ref" : "#/definitions/StorageUsageDTO" + }, + "contentRepositoryStorageUsage" : { + "type" : "array", + "description" : "The content repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "provenanceRepositoryStorageUsage" : { + "type" : "array", + "description" : "The provenance repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "garbageCollection" : { + "type" : "array", + "description" : "The garbage collection details.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/GarbageCollectionDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "When the diagnostics were generated." + }, + "versionInfo" : { + "description" : "The nifi, os, java, and build version information", + "$ref" : "#/definitions/VersionInfoDTO" + } + } + }, + "TemplateDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI for the template." + }, + "id" : { + "type" : "string", + "description" : "The id of the template." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the Process Group that the template belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when this template was created." + }, + "encodingVersion" : { + "type" : "string", + "xml" : { + "name" : "encoding-version", + "attribute" : true + }, + "description" : "The encoding version of this template." + }, + "snippet" : { + "description" : "The contents of the template.", + "$ref" : "#/definitions/FlowSnippetDTO" + } + }, + "xml" : { + "name" : "template" + } + }, + "TemplateEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "template" : { + "$ref" : "#/definitions/TemplateDTO" + } + }, + "xml" : { + "name" : "templateEntity" + } + }, + "TemplatesEntity" : { + "type" : "object", + "properties" : { + "templates" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + } + }, + "xml" : { + "name" : "templatesEntity" + } + }, + "TenantDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + } + } + }, + "TenantEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/TenantDTO" + } + }, + "xml" : { + "name" : "tenantEntity" + } + }, + "TenantsEntity" : { + "type" : "object", + "properties" : { + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + }, + "xml" : { + "name" : "tenantsEntity" + } + }, + "TransactionResultEntity" : { + "type" : "object", + "properties" : { + "flowFileSent" : { + "type" : "integer", + "format" : "int32" + }, + "responseCode" : { + "type" : "integer", + "format" : "int32" + }, + "message" : { + "type" : "string" + } + }, + "xml" : { + "name" : "transactionResultEntity" + } + }, + "UpdateControllerServiceReferenceRequestEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The identifier of the Controller Service." + }, + "state" : { + "type" : "string", + "description" : "The new state of the references for the controller service.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] + }, + "referencingComponentRevisions" : { + "type" : "object", + "description" : "The revisions for all referencing components.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "updateControllerServiceReferenceRequestEntity" + } + }, + "UserDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies this user belongs to.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummaryEntity" + } + } + } + }, + "UserEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserDTO" + } + }, + "xml" : { + "name" : "userEntity" + } + }, + "UserGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "users" : { + "type" : "array", + "description" : "The users that belong to the user group.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "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.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } + } + }, + "UserGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserGroupDTO" + } + }, + "xml" : { + "name" : "userGroupEntity" + } + }, + "UserGroupsEntity" : { + "type" : "object", + "properties" : { + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } + }, + "xml" : { + "name" : "userGroupsEntity" + } + }, + "UsersEntity" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserEntity" + } + } + }, + "xml" : { + "name" : "usersEntity" + } + }, + "VariableDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the variable" + }, + "value" : { + "type" : "string", + "description" : "The value of the variable" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group where this Variable is defined", + "readOnly" : true + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableEntity" : { + "type" : "object", + "properties" : { + "variable" : { + "description" : "The variable information", + "$ref" : "#/definitions/VariableDTO" + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "variableEntity" + } + }, + "VariableRegistryDTO" : { + "type" : "object", + "properties" : { + "variables" : { + "type" : "array", + "description" : "The variables that are available in this Variable Registry", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VariableEntity" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this Variable Registry belongs to" + } + } + }, + "VariableRegistryEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision of the Process Group that the Variable Registry belongs to", + "$ref" : "#/definitions/RevisionDTO" + }, + "variableRegistry" : { + "description" : "The Variable Registry.", + "$ref" : "#/definitions/VariableRegistryDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "variableRegistryEntity" + } + }, + "VariableRegistryUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableRegistryUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Variable Registry Update Request", + "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "variableRegistryUpdateRequestEntity" + } + }, + "VariableRegistryUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "VersionControlComponentMappingEntity" : { + "type" : "object", + "properties" : { + "versionControlComponentMapping" : { + "type" : "object", + "description" : "The mapping of Versioned Component Identifiers to instance ID's", + "additionalProperties" : { + "type" : "string" + } + }, + "processGroupRevision" : { + "description" : "The revision of the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlComponentMappingEntity" + } + }, + "VersionControlInformationDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that is under version control" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is stored in" + }, + "registryName" : { + "type" : "string", + "description" : "The name of the registry that the flow is stored in", + "readOnly" : true + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket that the flow is stored in" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket that the flow is stored in", + "readOnly" : true + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "flowDescription" : { + "type" : "string", + "description" : "The description of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "state" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "stateExplanation" : { + "type" : "string", + "description" : "Explanation of why the group is in the specified state", + "readOnly" : true + } + } + }, + "VersionControlInformationEntity" : { + "type" : "object", + "properties" : { + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "processGroupRevision" : { + "description" : "The Revision for the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionControlInformationEntity" + } + }, + "VersionInfoDTO" : { + "type" : "object", + "properties" : { + "niFiVersion" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "javaVendor" : { + "type" : "string", + "description" : "Java JVM vendor" + }, + "javaVersion" : { + "type" : "string", + "description" : "Java version" + }, + "osName" : { + "type" : "string", + "description" : "Host operating system name" + }, + "osVersion" : { + "type" : "string", + "description" : "Host operating system version" + }, + "osArchitecture" : { + "type" : "string", + "description" : "Host operating system architecture" + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Build timestamp" + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "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." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/Bundle" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "readOnly" : true, + "minimum" : 0 + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDTO" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is tracked to" + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket where the flow is stored" + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "description" : { + "type" : "string", + "description" : "A description of the flow" + }, + "comments" : { + "type" : "string", + "description" : "Comments for the changeset" + }, + "action" : { + "type" : "string", + "description" : "The action being performed", + "enum" : [ "COMMIT", "FORCE_COMMIT" ] + } + } + }, + "VersionedFlowEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + } + }, + "xml" : { + "name" : "versionedFlowEntity" + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "required" : [ "flowContents", "snapshotMetadata" ], + "properties" : { + "snapshotMetadata" : { + "description" : "The metadata for this snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "flowContents" : { + "description" : "The contents of the versioned flow", + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterContexts" : { + "type" : "object", + "description" : "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.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "flow" : { + "description" : "The flow this snapshot is for", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlow" + }, + "bucket" : { + "description" : "The bucket where the flow is located", + "readOnly" : true, + "$ref" : "#/definitions/Bucket" + }, + "latest" : { + "type" : "boolean" + } + } + }, + "VersionedFlowSnapshotEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshot" : { + "description" : "The versioned flow snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + }, + "updateDescendantVersionedFlows" : { + "type" : "boolean", + "description" : "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." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionedFlowSnapshotEntity" + } + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to." + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "readOnly" : true + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + } + } + }, + "VersionedFlowSnapshotMetadataEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadata" : { + "description" : "The collection of versioned flow snapshot metadata", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataEntity" + } + }, + "VersionedFlowSnapshotMetadataSetEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadataSet" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataSetEntity" + } + }, + "VersionedFlowUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this request has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this request failed, or null if this request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + }, + "versionControlInformation" : { + "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", + "readOnly" : true, + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "VersionedFlowUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Versioned Flow Update Request", + "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "versionedFlowUpdateRequestEntity" + } + }, + "VersionedFlowsEntity" : { + "type" : "object", + "properties" : { + "versionedFlows" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowsEntity" + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the context" + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "The type of Processor" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + } + } +} \ No newline at end of file diff --git a/resources/client_gen/generate_api_client.sh b/resources/client_gen/generate_api_client.sh index 50657875..7e5f2996 100755 --- a/resources/client_gen/generate_api_client.sh +++ b/resources/client_gen/generate_api_client.sh @@ -8,7 +8,7 @@ # Params echo Exporting Params -export wv_client_name=${wv_client_name:-registry} +export wv_client_name=${wv_client_name:-nifi} export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-2.3.1.jar} export wv_tmp_dir=${wv_tmp_dir:-${HOME}/Projects/tmp} diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index fa6b435d..f7a94c11 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,7 +2,7 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.9.2 + image: apache/nifi:1.10.0 container_name: nifi hostname: nifi ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index f84b8854..c782fef2 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.1' services: secure-nifi: - image: apache/nifi:1.9.2 + image: apache/nifi:1.10.0 container_name: secure-nifi hostname: secure-nifi ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index b96dac63..b5ca0898 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -19,7 +19,7 @@ services: ports: - "10180:8080" nifi: - image: apache/nifi:1.9.2 + image: apache/nifi:1.10.0 container_name: nifi hostname: nifi ports: diff --git a/setup.cfg b/setup.cfg index 7b727c2e..1c245567 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.13.3 +current_version = 0.14.0 commit = True tag = True diff --git a/setup.py b/setup.py index 4e4137c5..06eeee5a 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ with open('docs/history.rst') as history_file: history = history_file.read() -proj_version = '0.13.3' +proj_version = '0.14.0' with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() diff --git a/tests/conftest.py b/tests/conftest.py index a45e8b5f..0e4dcc50 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -330,11 +330,19 @@ def cleanup_nifi(): remove_test_processors() remove_test_ports() remove_test_funnels() + remove_test_rpgs() if test_security and 'https' in nipyapi.nifi.configuration.host: remove_test_service_user_groups('nifi') remove_test_service_users('nifi') +def remove_test_rpgs(): + _ = [ + nipyapi.canvas.delete_remote_process_group(x) + for x in nipyapi.canvas.list_all_remote_process_groups() + ] + + def remove_test_connections(): # Funnels don't have a name, have to go by type _ = [ diff --git a/tests/test_canvas.py b/tests/test_canvas.py index c7d80ba4..dcf16d35 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -332,6 +332,7 @@ def test_update_variable_registry(fix_pg): _ = canvas.update_variable_registry(test_pg, '') + def test_purge_connection(): # TODO: Waiting for create_connection to generate fixture pass @@ -650,3 +651,17 @@ def test_client_recursion_limit(fix_pg, fix_funnel, target=450): print("Len {0} Set {1}".format(len(r1), len(set([x.id for x in r1])))) print("Elapsed r1: {0}".format((end - start))) + +def test_remote_process_group_controls(): + rpg1 = canvas.create_remote_process_group('http://localhost:8080/nifi') + assert isinstance(rpg1, nifi.RemoteProcessGroupEntity) + assert rpg1.revision is not None + r1 = canvas.set_remote_process_group_transmission(rpg1) + assert isinstance(r1, nifi.RemoteProcessGroupEntity) + assert r1.status.transmission_status == 'Transmitting' + r2 = canvas.set_remote_process_group_transmission(rpg1, False) + assert isinstance(r2, nifi.RemoteProcessGroupEntity) + assert r2.status.transmission_status == 'NotTransmitting' + r3 = canvas.delete_remote_process_group(rpg1) + assert isinstance(r3, nifi.RemoteProcessGroupEntity) + assert r3.revision is None From 0ef433b0ed4f2b3c5964f7c88862b0f250f12b42 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 11 Dec 2019 10:04:27 +0000 Subject: [PATCH 20/40] Reproduce and fix issue where using NiFI-1.10 objects against NiFi-1.9 fails for VersionedFlowDTO Objects due to backwards compatibility issue in NiFi API --- nipyapi/versioning.py | 44 +++++++++++++------- requirements_dev.txt | 2 +- resources/docker/tox-full/docker-compose.yml | 14 +++++++ tests/conftest.py | 5 +++ 4 files changed, 50 insertions(+), 15 deletions(-) diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 0425010e..3165b8a7 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -210,7 +210,7 @@ def get_flow_in_bucket(bucket_id, identifier, identifier_type='name'): def save_flow_ver(process_group, registry_client, bucket, flow_name=None, - flow_id=None, comment='', desc='', refresh=True): + 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 @@ -228,7 +228,8 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, 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 + refresh (bool): Whether to refresh the object revisions before action + force (bool): Whether to Force Commit, or just regular Commit Returns: (VersionControlInformationEntity) @@ -237,21 +238,36 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, target_pg = nipyapi.canvas.get_process_group(process_group.id, 'id') else: target_pg = process_group + if nipyapi.utils.check_version('1.10.0') <= 0: + body = nipyapi.nifi.StartVersionControlRequestEntity( + process_group_revision=target_pg.revision, + versioned_flow=nipyapi.nifi.VersionedFlowDTO( + bucket_id=bucket.identifier, + comments=comment, + description=desc, + flow_name=flow_name, + flow_id=flow_id, + registry_id=registry_client.id, + action='FORCE_COMMIT' if force else 'COMMIT' + ) + ) + else: + # Prior versions of NiFi do not have the 'action' property and will fail + body = nipyapi.nifi.StartVersionControlRequestEntity( + process_group_revision=target_pg.revision, + versioned_flow={ + 'bucketId': bucket.identifier, + 'comments': comment, + 'description': desc, + 'flowName': flow_name, + 'flowId': flow_id, + 'registryId': registry_client.id + } + ) with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.VersionsApi().save_to_flow_registry( id=target_pg.id, - body=nipyapi.nifi.StartVersionControlRequestEntity( - process_group_revision=target_pg.revision, - versioned_flow=nipyapi.nifi.VersionedFlowDTO( - bucket_id=bucket.identifier, - comments=comment, - description=desc, - flow_name=flow_name, - flow_id=flow_id, - registry_id=registry_client.id, - action='COMMIT' - ) - ) + body=body ) diff --git a/requirements_dev.txt b/requirements_dev.txt index f4c1854e..362f9592 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -7,6 +7,7 @@ bumpversion>=0.5.3 watchdog>=0.8.3 twine>=1.9.1,<2.0.0 # pyup: ignore virtualenvwrapper>=4.8 +virtualenv>=16.0.0 # required for tox 3.14.2 but not forced # Testing tox>=2.9.1 @@ -28,4 +29,3 @@ cryptography>=2.1.2 py>=1.4.31 randomize>=0.13 certifi>=2017.7.27.1 -virtualenvwrapper>=4.8 diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index b5ca0898..1d961e08 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -18,6 +18,12 @@ services: hostname: nifi-180 ports: - "10180:8080" + nifi-192: + image: apache/nifi:1.9.2 + container_name: nifi-192 + hostname: nifi-192 + ports: + - "10192:8080" nifi: image: apache/nifi:1.10.0 container_name: nifi @@ -32,6 +38,14 @@ services: - "18010:18010" environment: - NIFI_REGISTRY_WEB_HTTP_PORT=18010 + registry-030: + image: apache/nifi-registry:0.3.0 + container_name: registry-030 + hostname: registry-030 + ports: + - "18030:18030" + environment: + - NIFI_REGISTRY_WEB_HTTP_PORT=18030 registry: image: apache/nifi-registry:0.5.0 container_name: registry diff --git a/tests/conftest.py b/tests/conftest.py index 0e4dcc50..10653ebf 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -55,6 +55,7 @@ 'http://' + test_host + ':10112/nifi-api', 'http://' + test_host + ':10120/nifi-api', 'http://' + test_host + ':10180/nifi-api', + 'http://' + test_host + ':10192/nifi-api', ] secure_nifi_endpoints = ['https://' + test_host + ':8443/nifi-api'] default_registry_endpoints = [ @@ -67,6 +68,10 @@ ('http://' + test_host + ':18010/nifi-registry-api', 'http://registry-010:18010', 'http://' + test_host + ':8080/nifi-api' + ), + ('http://' + test_host + ':18030/nifi-registry-api', + 'http://registry-030:18030', + 'http://' + test_host + ':10192/nifi-api' ) ] secure_registry_endpoints = [ From 1b315f0d4da6149687975c8d198bc9a6a187632b Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Wed, 11 Dec 2019 13:45:46 +0000 Subject: [PATCH 21/40] Fixes #163 Fix a couple docstrings Reformat a couple of lines for lint compliance --- nipyapi/templates.py | 6 +- nipyapi/utils.py | 1 + nipyapi/versioning.py | 5 +- .../nipyapi_testTemplate_00_greedy.xml | 251 ++++++++++++++++++ tests/test_templates.py | 26 ++ 5 files changed, 285 insertions(+), 4 deletions(-) create mode 100644 tests/resources/nipyapi_testTemplate_00_greedy.xml diff --git a/nipyapi/templates.py b/nipyapi/templates.py index 032b90f2..16d5cf2c 100644 --- a/nipyapi/templates.py +++ b/nipyapi/templates.py @@ -46,7 +46,7 @@ def get_template_by_name(name): return None -def get_template(identifier, identifier_type='name'): +def 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 @@ -54,6 +54,7 @@ def get_template(identifier, identifier_type='name'): Args: 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, @@ -65,7 +66,8 @@ def get_template(identifier, identifier_type='name'): with nipyapi.utils.rest_exceptions(): obj = nipyapi.templates.list_all_templates(native=False) if obj: - return nipyapi.utils.filter_obj(obj, identifier, identifier_type) + return nipyapi.utils.filter_obj(obj, identifier, identifier_type, + greedy) return obj diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 8df1931b..52566abc 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -513,6 +513,7 @@ def bypass_slash_encoding(service, bypass): @contextmanager def rest_exceptions(): + """Simple exception wrapper for Rest Exceptions""" try: yield except (nipyapi.nifi.rest.ApiException, diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 3165b8a7..1077ee6c 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -210,7 +210,8 @@ def get_flow_in_bucket(bucket_id, identifier, identifier_type='name'): def save_flow_ver(process_group, registry_client, bucket, flow_name=None, - flow_id=None, comment='', desc='', refresh=True, force=False): + 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 @@ -252,7 +253,7 @@ def save_flow_ver(process_group, registry_client, bucket, flow_name=None, ) ) else: - # Prior versions of NiFi do not have the 'action' property and will fail + # no 'action' property in versions < 1.10 body = nipyapi.nifi.StartVersionControlRequestEntity( process_group_revision=target_pg.revision, versioned_flow={ diff --git a/tests/resources/nipyapi_testTemplate_00_greedy.xml b/tests/resources/nipyapi_testTemplate_00_greedy.xml new file mode 100644 index 00000000..c2134e33 --- /dev/null +++ b/tests/resources/nipyapi_testTemplate_00_greedy.xml @@ -0,0 +1,251 @@ + + diff --git a/tests/test_templates.py b/tests/test_templates.py index 87362d49..3100e228 100644 --- a/tests/test_templates.py +++ b/tests/test_templates.py @@ -77,6 +77,32 @@ def test_get_templates_by_name(regress_nifi, fix_templates): assert isinstance(r, nipyapi.nifi.TemplateEntity) +def test_get_template(regress_nifi, fix_templates): + pg = fix_templates.pg.generate() + _ = nipyapi.templates.upload_template( + pg.id, + fix_templates.b_file + ) + r0 = nipyapi.templates.get_template(fix_templates.b_name) + assert r0 is not None + assert isinstance(r0, nipyapi.nifi.TemplateEntity) + r1 = nipyapi.templates.get_template(fix_templates.b_name, greedy=True) + assert r1 is not None + assert isinstance(r1, nipyapi.nifi.TemplateEntity) + _ = nipyapi.templates.upload_template( + pg.id, + fix_templates.g_file + ) + r3 = nipyapi.templates.get_template(fix_templates.b_name) + assert r3 is not None + assert isinstance(r3, nipyapi.nifi.TemplateEntity) + r4 = nipyapi.templates.get_template(fix_templates.b_name, greedy=True) + assert r4 is not None + assert isinstance(r4, list) + assert isinstance(r4[0], nipyapi.nifi.TemplateEntity) + assert len(r4) == 2 + + def test_deploy_template(regress_nifi, fix_templates): pg = fix_templates.pg.generate() t1 = nipyapi.templates.upload_template( From b5297c2d825ba47be729e7906292f44ae9f9f642 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Sat, 1 Feb 2020 17:31:06 +0000 Subject: [PATCH 22/40] Fixes #163 Fix a couple docstrings Reformat a couple of lines for lint compliance --- docs/devnotes.rst | 31 +++++++++++++++++++++++++++ nipyapi/canvas.py | 18 +++++++++++----- nipyapi/security.py | 6 ++++-- nipyapi/utils.py | 2 ++ resources/test_setup/setup_centos7.sh | 19 ++++++++++++++++ tests/conftest.py | 11 +++++++++- tests/test_canvas.py | 19 +++++++++++++++- tests/test_security.py | 2 ++ 8 files changed, 99 insertions(+), 9 deletions(-) create mode 100644 resources/test_setup/setup_centos7.sh diff --git a/docs/devnotes.rst b/docs/devnotes.rst index 333b70e5..d3d3d3af 100644 --- a/docs/devnotes.rst +++ b/docs/devnotes.rst @@ -14,6 +14,13 @@ Decision Points * 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 ----------------------- @@ -23,6 +30,30 @@ There is an Apache NiFi image available on Dockerhub:: 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 + 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//resources/docker/tox-full and run:: + + docker-compose pull + docker-compose up -d + Testing on OSX -------------- diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 7a2779de..506158da 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -1338,14 +1338,16 @@ def get_remote_process_group(rpg_id, summary=False): return out -def create_remote_process_group(target_uris, transport='RAW', pg_id='root', position=None): +def create_remote_process_group(target_uris, transport='RAW', pg_id='root', + position=None): """ Creates a new Remote Process Group with given parameters Args: 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 + pg_id (str): optional, UUID of parent Process Group for remote + process group position (tuple): optional, tuple of location ints Returns: @@ -1388,8 +1390,9 @@ def delete_remote_process_group(rpg, refresh=True): assert isinstance(rpg, nipyapi.nifi.RemoteProcessGroupEntity) if refresh: rpg = get_remote_process_group(rpg.id) + handle = nipyapi.nifi.RemoteProcessGroupsApi() with nipyapi.utils.rest_exceptions(): - return nipyapi.nifi.RemoteProcessGroupsApi().remove_remote_process_group( + return handle.remove_remote_process_group( id=rpg.id, version=rpg.revision.version ) @@ -1397,9 +1400,11 @@ def delete_remote_process_group(rpg, refresh=True): def set_remote_process_group_transmission(rpg, enable=True, refresh=True): """ + Enable or Disable Transmission for an RPG Args: - rpg (RemoteProcessGroupEntity): The ID of the remote process group to modify + 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 @@ -1410,8 +1415,9 @@ def set_remote_process_group_transmission(rpg, enable=True, refresh=True): assert isinstance(enable, bool) if refresh: rpg = get_remote_process_group(rpg.id) + handle = nipyapi.nifi.RemoteProcessGroupsApi() with nipyapi.utils.rest_exceptions(): - return nipyapi.nifi.RemoteProcessGroupsApi().update_remote_process_group_run_status( + return handle.update_remote_process_group_run_status( id=rpg.id, body=nipyapi.nifi.RemotePortRunStatusEntity( state='TRANSMITTING' if enable else 'STOPPED', @@ -1482,6 +1488,7 @@ def get_funnel(funnel_id): def create_funnel(pg_id, position=None): """ + Creates a Funnel Object Args: pg_id (str): ID of the parent Process Group @@ -1510,6 +1517,7 @@ def create_funnel(pg_id, position=None): def delete_funnel(funnel, refresh=True): """ + Deletes a Funnel Object Args: funnel (FunnelEntity): The Funnel to delete diff --git a/nipyapi/security.py b/nipyapi/security.py index e3ac8615..d9c13be7 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -145,7 +145,7 @@ def create_service_user_group(identity, service='nifi', Args: identity (str): Identity string for the user group service (str): 'nifi' or 'registry' - users (list): A list of UserEntities belonging to the group + 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: @@ -751,7 +751,9 @@ def bootstrap_security_policies(service, user_identity=None, None """ - assert service in _valid_services + assert service in _valid_services, "service not in %s" % _valid_services + if user_identity is not None: + assert user_identity in [nipyapi.nifi.UserEntity, nipyapi.registry.User] if 'nifi' in service: rpg_id = nipyapi.canvas.get_root_pg_id() if user_identity is None and group_identity is None: diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 52566abc..5a2d731f 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -476,6 +476,8 @@ def infer_object_label_from_class(obj): return 'FUNNEL' if isinstance(obj, nipyapi.nifi.PortEntity): return obj.port_type + if isinstance(obj, nipyapi.nifi.RemoteProcessGroupDTO): + return 'REMOTEPROCESSGROUP' if isinstance(obj, nipyapi.nifi.RemoteProcessGroupPortDTO): # get RPG summary, find id of obj in input or output list parent_rpg = nipyapi.canvas.get_remote_process_group( diff --git a/resources/test_setup/setup_centos7.sh b/resources/test_setup/setup_centos7.sh new file mode 100644 index 00000000..c074d460 --- /dev/null +++ b/resources/test_setup/setup_centos7.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash + +set -x +set -e +set -u + +sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo +sudo yum update -y +sudo yum install -y centos-release-scl yum-utils device-mapper-persistent-data lvm2 +sudo yum install -y rh-python36 docker +sudo systemctl start docker +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 +source /opt/rh/python36/enable +pip install --upgrade pip +pip install -r ../../requirements.txt +pip install -r ../../requirements_dev.txts + diff --git a/tests/conftest.py b/tests/conftest.py index 10653ebf..c4f782a7 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -43,6 +43,7 @@ # Test template filenames should match the template PG name test_templates = { 'basic': test_basename + 'Template_00', + 'greedy': test_basename + 'Template_00_greedy', 'complex': test_basename + 'Template_01' } @@ -394,7 +395,7 @@ def fixture_templates(request, fix_pg): nipyapi.config.nifi_config.host) FixtureTemplates = namedtuple( 'FixtureTemplates', ('pg', 'b_file', 'b_name', 'c_file', - 'c_name') + 'c_name', 'g_name', 'g_file') ) f_pg = fix_pg f_b_file = path.join( @@ -409,11 +410,19 @@ def fixture_templates(request, fix_pg): test_templates['complex'] + '.xml' ) f_c_name = 'nipyapi_testTemplate_01' + f_g_file = path.join( + path.dirname(__file__), + test_resource_dir, + test_templates['greedy'] + '.xml' + ) + f_g_name = 'nipyapi_testTemplate_00_greedy' out = FixtureTemplates( pg=f_pg, b_name=f_b_name, c_name=f_c_name, + g_name=f_g_name, b_file=f_b_file, + g_file=f_g_file, c_file=f_c_file ) request.addfinalizer(remove_test_templates) diff --git a/tests/test_canvas.py b/tests/test_canvas.py index dcf16d35..5bf54a9a 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -652,7 +652,7 @@ def test_client_recursion_limit(fix_pg, fix_funnel, target=450): print("Elapsed r1: {0}".format((end - start))) -def test_remote_process_group_controls(): +def test_remote_process_group_controls(fix_proc): rpg1 = canvas.create_remote_process_group('http://localhost:8080/nifi') assert isinstance(rpg1, nifi.RemoteProcessGroupEntity) assert rpg1.revision is not None @@ -662,6 +662,23 @@ def test_remote_process_group_controls(): r2 = canvas.set_remote_process_group_transmission(rpg1, False) assert isinstance(r2, nifi.RemoteProcessGroupEntity) assert r2.status.transmission_status == 'NotTransmitting' + # Handle connecting to an RPG + # p1 = fix_proc.generate() + # ip = canvas.create_port( + # pg_id=canvas.get_root_pg_id(), + # port_type='INPUT_PORT', + # name=conftest.test_basename + 'input_port', + # state='STOPPED' + # ) + # op = canvas.create_port( + # pg_id=canvas.get_root_pg_id(), + # port_type='OUTPUT_PORT', + # name=conftest.test_basename + 'input_port', + # state='STOPPED' + # ) + # c1 = canvas.create_connection(p1, rpg1) + # c2 = canvas.create_connection(rpg1, op) + # TODO: Need to test connecting to remote environment, not just loopback r3 = canvas.delete_remote_process_group(rpg1) assert isinstance(r3, nifi.RemoteProcessGroupEntity) assert r3.revision is None diff --git a/tests/test_security.py b/tests/test_security.py index 1056448c..97c59a7e 100644 --- a/tests/test_security.py +++ b/tests/test_security.py @@ -256,3 +256,5 @@ def test_set_service_ssl_context(): def test_bootstrap_security_policies(): # This test suite makes extensive use of this call in fixtures pass + +# TODO: Test adding users to existing set of users and ensuring no clobber From dd5286ad1cd29bb96126b07922c87d345c39e474 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Sat, 1 Feb 2020 19:09:24 +0000 Subject: [PATCH 23/40] Updated NiFi client to 1.11 Updated docker files to latest 1.11 build --- nipyapi/nifi/__init__.py | 2 +- nipyapi/nifi/api_client.py | 2 +- nipyapi/nifi/apis/access_api.py | 2 +- nipyapi/nifi/apis/connections_api.py | 2 +- nipyapi/nifi/apis/controller_api.py | 2 +- nipyapi/nifi/apis/controller_services_api.py | 2 +- nipyapi/nifi/apis/counters_api.py | 2 +- nipyapi/nifi/apis/data_transfer_api.py | 2 +- nipyapi/nifi/apis/flow_api.py | 2 +- nipyapi/nifi/apis/flowfile_queues_api.py | 2 +- nipyapi/nifi/apis/funnel_api.py | 2 +- nipyapi/nifi/apis/input_ports_api.py | 2 +- nipyapi/nifi/apis/labels_api.py | 2 +- nipyapi/nifi/apis/output_ports_api.py | 2 +- nipyapi/nifi/apis/parameter_contexts_api.py | 2 +- nipyapi/nifi/apis/policies_api.py | 2 +- nipyapi/nifi/apis/process_groups_api.py | 108 +- nipyapi/nifi/apis/processors_api.py | 2 +- nipyapi/nifi/apis/provenance_api.py | 2 +- nipyapi/nifi/apis/provenance_events_api.py | 2 +- .../nifi/apis/remote_process_groups_api.py | 2 +- nipyapi/nifi/apis/reporting_tasks_api.py | 2 +- nipyapi/nifi/apis/resources_api.py | 2 +- nipyapi/nifi/apis/site_to_site_api.py | 2 +- nipyapi/nifi/apis/snippets_api.py | 2 +- nipyapi/nifi/apis/system_diagnostics_api.py | 2 +- nipyapi/nifi/apis/templates_api.py | 2 +- nipyapi/nifi/apis/tenants_api.py | 2 +- nipyapi/nifi/apis/versions_api.py | 108 +- nipyapi/nifi/configuration.py | 4 +- nipyapi/nifi/models/__init__.py | 2 +- nipyapi/nifi/models/about_dto.py | 2 +- nipyapi/nifi/models/about_entity.py | 2 +- .../nifi/models/access_configuration_dto.py | 2 +- .../models/access_configuration_entity.py | 2 +- nipyapi/nifi/models/access_policy_dto.py | 2 +- nipyapi/nifi/models/access_policy_entity.py | 2 +- .../nifi/models/access_policy_summary_dto.py | 2 +- .../models/access_policy_summary_entity.py | 2 +- nipyapi/nifi/models/access_status_dto.py | 2 +- nipyapi/nifi/models/access_status_entity.py | 2 +- nipyapi/nifi/models/action_details_dto.py | 2 +- nipyapi/nifi/models/action_dto.py | 2 +- nipyapi/nifi/models/action_entity.py | 2 +- .../activate_controller_services_entity.py | 2 +- nipyapi/nifi/models/affected_component_dto.py | 2 +- .../nifi/models/affected_component_entity.py | 2 +- nipyapi/nifi/models/allowable_value_dto.py | 2 +- nipyapi/nifi/models/allowable_value_entity.py | 2 +- nipyapi/nifi/models/attribute_dto.py | 2 +- nipyapi/nifi/models/banner_dto.py | 2 +- nipyapi/nifi/models/banner_entity.py | 2 +- nipyapi/nifi/models/batch_settings_dto.py | 2 +- nipyapi/nifi/models/batch_size.py | 2 +- nipyapi/nifi/models/bucket.py | 2 +- nipyapi/nifi/models/bucket_dto.py | 2 +- nipyapi/nifi/models/bucket_entity.py | 2 +- nipyapi/nifi/models/buckets_entity.py | 2 +- nipyapi/nifi/models/bulletin_board_dto.py | 2 +- nipyapi/nifi/models/bulletin_board_entity.py | 2 +- nipyapi/nifi/models/bulletin_dto.py | 2 +- nipyapi/nifi/models/bulletin_entity.py | 2 +- nipyapi/nifi/models/bundle.py | 2 +- nipyapi/nifi/models/bundle_dto.py | 2 +- nipyapi/nifi/models/cluste_summary_entity.py | 2 +- nipyapi/nifi/models/cluster_dto.py | 2 +- nipyapi/nifi/models/cluster_entity.py | 2 +- .../models/cluster_search_results_entity.py | 2 +- nipyapi/nifi/models/cluster_summary_dto.py | 2 +- nipyapi/nifi/models/component_details_dto.py | 2 +- .../nifi/models/component_difference_dto.py | 2 +- nipyapi/nifi/models/component_history_dto.py | 2 +- .../nifi/models/component_history_entity.py | 2 +- .../nifi/models/component_reference_dto.py | 2 +- .../nifi/models/component_reference_entity.py | 2 +- .../component_restriction_permission_dto.py | 2 +- .../models/component_search_result_dto.py | 2 +- nipyapi/nifi/models/component_state_dto.py | 2 +- nipyapi/nifi/models/component_state_entity.py | 2 +- .../models/component_validation_result_dto.py | 2 +- .../component_validation_result_entity.py | 2 +- .../component_validation_results_entity.py | 2 +- nipyapi/nifi/models/connectable_component.py | 2 +- nipyapi/nifi/models/connectable_dto.py | 2 +- nipyapi/nifi/models/connection_dto.py | 2 +- nipyapi/nifi/models/connection_entity.py | 2 +- .../nifi/models/connection_statistics_dto.py | 2 +- .../models/connection_statistics_entity.py | 2 +- .../connection_statistics_snapshot_dto.py | 2 +- nipyapi/nifi/models/connection_status_dto.py | 2 +- .../nifi/models/connection_status_entity.py | 2 +- ...nection_status_predictions_snapshot_dto.py | 2 +- .../models/connection_status_snapshot_dto.py | 2 +- .../connection_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/connections_entity.py | 2 +- .../models/controller_bulletins_entity.py | 2 +- .../models/controller_configuration_dto.py | 2 +- .../models/controller_configuration_entity.py | 2 +- nipyapi/nifi/models/controller_dto.py | 2 +- nipyapi/nifi/models/controller_entity.py | 2 +- nipyapi/nifi/models/controller_service_api.py | 2 +- .../nifi/models/controller_service_api_dto.py | 2 +- nipyapi/nifi/models/controller_service_dto.py | 2 +- .../nifi/models/controller_service_entity.py | 2 +- ...oller_service_referencing_component_dto.py | 2 +- ...er_service_referencing_component_entity.py | 2 +- ...r_service_referencing_components_entity.py | 2 +- .../controller_service_run_status_entity.py | 2 +- .../models/controller_service_status_dto.py | 2 +- .../models/controller_service_types_entity.py | 2 +- .../nifi/models/controller_services_entity.py | 2 +- nipyapi/nifi/models/controller_status_dto.py | 2 +- .../nifi/models/controller_status_entity.py | 2 +- .../models/copy_snippet_request_entity.py | 2 +- nipyapi/nifi/models/counter_dto.py | 2 +- nipyapi/nifi/models/counter_entity.py | 2 +- nipyapi/nifi/models/counters_dto.py | 2 +- nipyapi/nifi/models/counters_entity.py | 2 +- nipyapi/nifi/models/counters_snapshot_dto.py | 2 +- .../models/create_active_request_entity.py | 2 +- .../models/create_template_request_entity.py | 2 +- nipyapi/nifi/models/current_user_entity.py | 2 +- nipyapi/nifi/models/difference_dto.py | 2 +- nipyapi/nifi/models/dimensions_dto.py | 2 +- nipyapi/nifi/models/documented_type_dto.py | 2 +- nipyapi/nifi/models/drop_request_dto.py | 2 +- nipyapi/nifi/models/drop_request_entity.py | 2 +- .../nifi/models/explicit_restriction_dto.py | 2 +- .../external_controller_service_reference.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_dto.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_entity.py | 2 +- nipyapi/nifi/models/flow_comparison_entity.py | 2 +- nipyapi/nifi/models/flow_configuration_dto.py | 2 +- .../nifi/models/flow_configuration_entity.py | 2 +- nipyapi/nifi/models/flow_dto.py | 2 +- nipyapi/nifi/models/flow_entity.py | 2 +- nipyapi/nifi/models/flow_file_dto.py | 2 +- nipyapi/nifi/models/flow_file_entity.py | 2 +- nipyapi/nifi/models/flow_file_summary_dto.py | 2 +- nipyapi/nifi/models/flow_snippet_dto.py | 2 +- nipyapi/nifi/models/funnel_dto.py | 2 +- nipyapi/nifi/models/funnel_entity.py | 2 +- nipyapi/nifi/models/funnels_entity.py | 2 +- nipyapi/nifi/models/garbage_collection_dto.py | 2 +- nipyapi/nifi/models/history_dto.py | 2 +- nipyapi/nifi/models/history_entity.py | 2 +- nipyapi/nifi/models/input_ports_entity.py | 2 +- .../instantiate_template_request_entity.py | 2 +- nipyapi/nifi/models/jaxb_link.py | 2 +- nipyapi/nifi/models/label_dto.py | 2 +- nipyapi/nifi/models/label_entity.py | 2 +- nipyapi/nifi/models/labels_entity.py | 2 +- nipyapi/nifi/models/lineage_dto.py | 2 +- nipyapi/nifi/models/lineage_entity.py | 2 +- nipyapi/nifi/models/lineage_request_dto.py | 2 +- nipyapi/nifi/models/lineage_results_dto.py | 2 +- nipyapi/nifi/models/listing_request_dto.py | 2 +- nipyapi/nifi/models/listing_request_entity.py | 2 +- ...node_connection_statistics_snapshot_dto.py | 2 +- .../node_connection_status_snapshot_dto.py | 2 +- .../nifi/models/node_counters_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_dto.py | 2 +- nipyapi/nifi/models/node_entity.py | 2 +- nipyapi/nifi/models/node_event_dto.py | 2 +- .../models/node_port_status_snapshot_dto.py | 2 +- .../node_process_group_status_snapshot_dto.py | 2 +- .../node_processor_status_snapshot_dto.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_search_result_dto.py | 2 +- .../nifi/models/node_status_snapshots_dto.py | 2 +- .../node_system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/output_ports_entity.py | 2 +- nipyapi/nifi/models/parameter_context_dto.py | 2 +- .../nifi/models/parameter_context_entity.py | 2 +- .../models/parameter_context_reference_dto.py | 2 +- .../parameter_context_reference_entity.py | 2 +- .../parameter_context_update_request_dto.py | 2 +- ...parameter_context_update_request_entity.py | 2 +- .../parameter_context_update_step_dto.py | 2 +- ...arameter_context_validation_request_dto.py | 2 +- ...meter_context_validation_request_entity.py | 2 +- .../parameter_context_validation_step_dto.py | 2 +- .../nifi/models/parameter_contexts_entity.py | 2 +- nipyapi/nifi/models/parameter_dto.py | 2 +- nipyapi/nifi/models/parameter_entity.py | 2 +- nipyapi/nifi/models/peer_dto.py | 2 +- nipyapi/nifi/models/peers_entity.py | 2 +- nipyapi/nifi/models/permissions.py | 2 +- nipyapi/nifi/models/permissions_dto.py | 2 +- nipyapi/nifi/models/port_dto.py | 2 +- nipyapi/nifi/models/port_entity.py | 2 +- nipyapi/nifi/models/port_run_status_entity.py | 2 +- nipyapi/nifi/models/port_status_dto.py | 2 +- nipyapi/nifi/models/port_status_entity.py | 2 +- .../nifi/models/port_status_snapshot_dto.py | 2 +- .../models/port_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/position.py | 2 +- nipyapi/nifi/models/position_dto.py | 2 +- nipyapi/nifi/models/previous_value_dto.py | 2 +- .../nifi/models/prioritizer_types_entity.py | 2 +- nipyapi/nifi/models/process_group_dto.py | 2 +- nipyapi/nifi/models/process_group_entity.py | 2 +- nipyapi/nifi/models/process_group_flow_dto.py | 2 +- .../nifi/models/process_group_flow_entity.py | 2 +- nipyapi/nifi/models/process_group_name_dto.py | 2 +- .../nifi/models/process_group_status_dto.py | 2 +- .../models/process_group_status_entity.py | 2 +- .../process_group_status_snapshot_dto.py | 2 +- .../process_group_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/process_groups_entity.py | 2 +- nipyapi/nifi/models/processor_config_dto.py | 2 +- nipyapi/nifi/models/processor_dto.py | 2 +- nipyapi/nifi/models/processor_entity.py | 2 +- .../models/processor_run_status_entity.py | 2 +- nipyapi/nifi/models/processor_status_dto.py | 2 +- .../nifi/models/processor_status_entity.py | 2 +- .../models/processor_status_snapshot_dto.py | 2 +- .../processor_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/processor_types_entity.py | 2 +- nipyapi/nifi/models/processors_entity.py | 2 +- .../nifi/models/property_descriptor_dto.py | 2 +- .../nifi/models/property_descriptor_entity.py | 2 +- nipyapi/nifi/models/property_history_dto.py | 2 +- nipyapi/nifi/models/provenance_dto.py | 2 +- nipyapi/nifi/models/provenance_entity.py | 2 +- nipyapi/nifi/models/provenance_event_dto.py | 2 +- .../nifi/models/provenance_event_entity.py | 2 +- nipyapi/nifi/models/provenance_link_dto.py | 2 +- nipyapi/nifi/models/provenance_node_dto.py | 2 +- nipyapi/nifi/models/provenance_options_dto.py | 2 +- .../nifi/models/provenance_options_entity.py | 2 +- nipyapi/nifi/models/provenance_request_dto.py | 2 +- nipyapi/nifi/models/provenance_results_dto.py | 2 +- .../models/provenance_searchable_field_dto.py | 2 +- nipyapi/nifi/models/queue_size_dto.py | 2 +- nipyapi/nifi/models/registry_client_entity.py | 2 +- .../nifi/models/registry_clients_entity.py | 2 +- nipyapi/nifi/models/registry_dto.py | 2 +- nipyapi/nifi/models/relationship_dto.py | 2 +- .../models/remote_port_run_status_entity.py | 2 +- .../remote_process_group_contents_dto.py | 2 +- .../nifi/models/remote_process_group_dto.py | 2 +- .../models/remote_process_group_entity.py | 2 +- .../models/remote_process_group_port_dto.py | 2 +- .../remote_process_group_port_entity.py | 2 +- .../models/remote_process_group_status_dto.py | 2 +- .../remote_process_group_status_entity.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- ...te_process_group_status_snapshot_entity.py | 2 +- .../models/remote_process_groups_entity.py | 2 +- nipyapi/nifi/models/reporting_task_dto.py | 2 +- nipyapi/nifi/models/reporting_task_entity.py | 2 +- .../reporting_task_run_status_entity.py | 2 +- .../nifi/models/reporting_task_status_dto.py | 2 +- .../models/reporting_task_types_entity.py | 2 +- nipyapi/nifi/models/reporting_tasks_entity.py | 2 +- .../nifi/models/required_permission_dto.py | 2 +- nipyapi/nifi/models/resource_dto.py | 2 +- nipyapi/nifi/models/resources_entity.py | 2 +- nipyapi/nifi/models/revision_dto.py | 2 +- .../nifi/models/schedule_components_entity.py | 2 +- .../nifi/models/search_result_group_dto.py | 2 +- nipyapi/nifi/models/search_results_dto.py | 2 +- nipyapi/nifi/models/search_results_entity.py | 2 +- nipyapi/nifi/models/snippet_dto.py | 2 +- nipyapi/nifi/models/snippet_entity.py | 2 +- .../start_version_control_request_entity.py | 2 +- nipyapi/nifi/models/state_entry_dto.py | 2 +- nipyapi/nifi/models/state_map_dto.py | 2 +- nipyapi/nifi/models/status_descriptor_dto.py | 2 +- nipyapi/nifi/models/status_history_dto.py | 2 +- nipyapi/nifi/models/status_history_entity.py | 2 +- nipyapi/nifi/models/status_snapshot_dto.py | 2 +- nipyapi/nifi/models/storage_usage_dto.py | 2 +- nipyapi/nifi/models/streaming_output.py | 2 +- .../models/submit_replay_request_entity.py | 2 +- nipyapi/nifi/models/system_diagnostics_dto.py | 2 +- .../nifi/models/system_diagnostics_entity.py | 2 +- .../models/system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/template_dto.py | 2 +- nipyapi/nifi/models/template_entity.py | 2 +- nipyapi/nifi/models/templates_entity.py | 2 +- nipyapi/nifi/models/tenant_dto.py | 2 +- nipyapi/nifi/models/tenant_entity.py | 2 +- nipyapi/nifi/models/tenants_entity.py | 2 +- .../nifi/models/transaction_result_entity.py | 2 +- ...roller_service_reference_request_entity.py | 2 +- nipyapi/nifi/models/user_dto.py | 2 +- nipyapi/nifi/models/user_entity.py | 2 +- nipyapi/nifi/models/user_group_dto.py | 2 +- nipyapi/nifi/models/user_group_entity.py | 2 +- nipyapi/nifi/models/user_groups_entity.py | 2 +- nipyapi/nifi/models/users_entity.py | 2 +- nipyapi/nifi/models/variable_dto.py | 2 +- nipyapi/nifi/models/variable_entity.py | 2 +- nipyapi/nifi/models/variable_registry_dto.py | 2 +- .../nifi/models/variable_registry_entity.py | 2 +- .../variable_registry_update_request_dto.py | 2 +- ...variable_registry_update_request_entity.py | 2 +- .../variable_registry_update_step_dto.py | 2 +- ...ersion_control_component_mapping_entity.py | 2 +- .../models/version_control_information_dto.py | 2 +- .../version_control_information_entity.py | 2 +- nipyapi/nifi/models/version_info_dto.py | 2 +- nipyapi/nifi/models/versioned_connection.py | 2 +- .../models/versioned_controller_service.py | 2 +- nipyapi/nifi/models/versioned_flow.py | 2 +- .../nifi/models/versioned_flow_coordinates.py | 2 +- nipyapi/nifi/models/versioned_flow_dto.py | 2 +- nipyapi/nifi/models/versioned_flow_entity.py | 2 +- .../nifi/models/versioned_flow_snapshot.py | 2 +- .../models/versioned_flow_snapshot_entity.py | 2 +- .../versioned_flow_snapshot_metadata.py | 2 +- ...versioned_flow_snapshot_metadata_entity.py | 2 +- ...ioned_flow_snapshot_metadata_set_entity.py | 2 +- .../versioned_flow_update_request_dto.py | 2 +- .../versioned_flow_update_request_entity.py | 2 +- nipyapi/nifi/models/versioned_flows_entity.py | 2 +- nipyapi/nifi/models/versioned_funnel.py | 2 +- nipyapi/nifi/models/versioned_label.py | 2 +- nipyapi/nifi/models/versioned_parameter.py | 2 +- .../models/versioned_parameter_context.py | 2 +- nipyapi/nifi/models/versioned_port.py | 2 +- .../nifi/models/versioned_process_group.py | 2 +- nipyapi/nifi/models/versioned_processor.py | 2 +- .../models/versioned_property_descriptor.py | 2 +- .../models/versioned_remote_group_port.py | 2 +- .../models/versioned_remote_process_group.py | 2 +- nipyapi/nifi/rest.py | 2 +- .../client_gen/api_defs/nifi-1.11.1.json | 20689 ++++++++++++++++ resources/docker/latest/docker-compose.yml | 2 +- resources/docker/secure/docker-compose.yml | 2 +- resources/docker/tox-full/docker-compose.yml | 2 +- 333 files changed, 21234 insertions(+), 333 deletions(-) create mode 100644 resources/client_gen/api_defs/nifi-1.11.1.json diff --git a/nipyapi/nifi/__init__.py b/nipyapi/nifi/__init__.py index b8991446..1a569c98 100644 --- a/nipyapi/nifi/__init__.py +++ b/nipyapi/nifi/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index 4a15100b..a4e0d1aa 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -4,7 +4,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/access_api.py b/nipyapi/nifi/apis/access_api.py index 5531aa02..b6348dae 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/connections_api.py b/nipyapi/nifi/apis/connections_api.py index fb88c5c8..505b0d17 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index fcc49e0a..667a7269 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_services_api.py b/nipyapi/nifi/apis/controller_services_api.py index 0c87aa3b..fc89d578 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/counters_api.py b/nipyapi/nifi/apis/counters_api.py index b1f30c6a..8d64ca65 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/data_transfer_api.py b/nipyapi/nifi/apis/data_transfer_api.py index 851f29f7..705e0335 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/flow_api.py b/nipyapi/nifi/apis/flow_api.py index d7868da5..fd30ee40 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/flowfile_queues_api.py b/nipyapi/nifi/apis/flowfile_queues_api.py index 824cf6ea..59934672 100644 --- a/nipyapi/nifi/apis/flowfile_queues_api.py +++ b/nipyapi/nifi/apis/flowfile_queues_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/funnel_api.py b/nipyapi/nifi/apis/funnel_api.py index 24d375c5..aa95d876 100644 --- a/nipyapi/nifi/apis/funnel_api.py +++ b/nipyapi/nifi/apis/funnel_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/input_ports_api.py b/nipyapi/nifi/apis/input_ports_api.py index c174c532..c534cbe7 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/labels_api.py b/nipyapi/nifi/apis/labels_api.py index 87d40b9e..8e9b0558 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/output_ports_api.py b/nipyapi/nifi/apis/output_ports_api.py index cd43a78e..6cdd7df3 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/parameter_contexts_api.py b/nipyapi/nifi/apis/parameter_contexts_api.py index c59ff626..58b0173d 100644 --- a/nipyapi/nifi/apis/parameter_contexts_api.py +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/policies_api.py b/nipyapi/nifi/apis/policies_api.py index 46e1c38e..8af37d4e 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/process_groups_api.py b/nipyapi/nifi/apis/process_groups_api.py index 31f6da0a..1312638d 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -1400,6 +1400,112 @@ def delete_variable_registry_update_request_with_http_info(self, group_id, updat _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def export_process_group(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.export_process_group_with_http_info(id, **kwargs) + else: + (data) = self.export_process_group_with_http_info(id, **kwargs) + return data + + def export_process_group_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method export_process_group" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `export_process_group`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/process-groups/{id}/download', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_connections(self, id, **kwargs): """ Gets all connections diff --git a/nipyapi/nifi/apis/processors_api.py b/nipyapi/nifi/apis/processors_api.py index 3d447c01..b43c15f6 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index 8f81920b..c8903dab 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_events_api.py b/nipyapi/nifi/apis/provenance_events_api.py index 7e1a1dc0..77a1457a 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/remote_process_groups_api.py b/nipyapi/nifi/apis/remote_process_groups_api.py index 51efe7d6..8389ecab 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/reporting_tasks_api.py b/nipyapi/nifi/apis/reporting_tasks_api.py index ac5391f7..ef4521b9 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/resources_api.py b/nipyapi/nifi/apis/resources_api.py index e6cb107a..af7d122c 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/site_to_site_api.py b/nipyapi/nifi/apis/site_to_site_api.py index 003b560d..c40da03a 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/snippets_api.py b/nipyapi/nifi/apis/snippets_api.py index f2a71809..d48a1985 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/system_diagnostics_api.py b/nipyapi/nifi/apis/system_diagnostics_api.py index fae94739..7e23a857 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/templates_api.py b/nipyapi/nifi/apis/templates_api.py index 8882986f..76b6adc8 100644 --- a/nipyapi/nifi/apis/templates_api.py +++ b/nipyapi/nifi/apis/templates_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/tenants_api.py b/nipyapi/nifi/apis/tenants_api.py index 0eaecf1a..353cfa2a 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/versions_api.py b/nipyapi/nifi/apis/versions_api.py index b9f4bb09..050c2cb9 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -476,6 +476,112 @@ def delete_version_control_request_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def export_flow_version(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.export_flow_version_with_http_info(id, **kwargs) + else: + (data) = self.export_flow_version_with_http_info(id, **kwargs) + return data + + def export_flow_version_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: str + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method export_flow_version" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `export_flow_version`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/versions/process-groups/{id}/download', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_revert_request(self, id, **kwargs): """ Returns the Revert Request with the given ID diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 432f5720..48eed0c7 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -228,6 +228,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.10.0\n"\ + "Version of the API: 1.11.1-SNAPSHOT\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/nifi/models/__init__.py b/nipyapi/nifi/models/__init__.py index bc65572d..bc53ae32 100644 --- a/nipyapi/nifi/models/__init__.py +++ b/nipyapi/nifi/models/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/about_dto.py b/nipyapi/nifi/models/about_dto.py index 7ca899b4..506f3f39 100644 --- a/nipyapi/nifi/models/about_dto.py +++ b/nipyapi/nifi/models/about_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/about_entity.py b/nipyapi/nifi/models/about_entity.py index 3b4171ae..0059fd1a 100644 --- a/nipyapi/nifi/models/about_entity.py +++ b/nipyapi/nifi/models/about_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_dto.py b/nipyapi/nifi/models/access_configuration_dto.py index 2eb434da..d3cbd518 100644 --- a/nipyapi/nifi/models/access_configuration_dto.py +++ b/nipyapi/nifi/models/access_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_entity.py b/nipyapi/nifi/models/access_configuration_entity.py index 408e6a7d..9ed89777 100644 --- a/nipyapi/nifi/models/access_configuration_entity.py +++ b/nipyapi/nifi/models/access_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_dto.py b/nipyapi/nifi/models/access_policy_dto.py index 5ed63c33..44428c47 100644 --- a/nipyapi/nifi/models/access_policy_dto.py +++ b/nipyapi/nifi/models/access_policy_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_entity.py b/nipyapi/nifi/models/access_policy_entity.py index fb977d6d..7d22df11 100644 --- a/nipyapi/nifi/models/access_policy_entity.py +++ b/nipyapi/nifi/models/access_policy_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_dto.py b/nipyapi/nifi/models/access_policy_summary_dto.py index 1941664d..242e4696 100644 --- a/nipyapi/nifi/models/access_policy_summary_dto.py +++ b/nipyapi/nifi/models/access_policy_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_entity.py b/nipyapi/nifi/models/access_policy_summary_entity.py index 0570b7d8..b8e89862 100644 --- a/nipyapi/nifi/models/access_policy_summary_entity.py +++ b/nipyapi/nifi/models/access_policy_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_dto.py b/nipyapi/nifi/models/access_status_dto.py index 155f03c1..70e4db66 100644 --- a/nipyapi/nifi/models/access_status_dto.py +++ b/nipyapi/nifi/models/access_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_entity.py b/nipyapi/nifi/models/access_status_entity.py index bb4297f8..f4b7e6ae 100644 --- a/nipyapi/nifi/models/access_status_entity.py +++ b/nipyapi/nifi/models/access_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_details_dto.py b/nipyapi/nifi/models/action_details_dto.py index 7b91d8a0..97cee28a 100644 --- a/nipyapi/nifi/models/action_details_dto.py +++ b/nipyapi/nifi/models/action_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_dto.py b/nipyapi/nifi/models/action_dto.py index 9ac2f541..a7155d85 100644 --- a/nipyapi/nifi/models/action_dto.py +++ b/nipyapi/nifi/models/action_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_entity.py b/nipyapi/nifi/models/action_entity.py index 7c59c5a4..b60e755c 100644 --- a/nipyapi/nifi/models/action_entity.py +++ b/nipyapi/nifi/models/action_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/activate_controller_services_entity.py b/nipyapi/nifi/models/activate_controller_services_entity.py index c7787fef..a987976a 100644 --- a/nipyapi/nifi/models/activate_controller_services_entity.py +++ b/nipyapi/nifi/models/activate_controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_dto.py b/nipyapi/nifi/models/affected_component_dto.py index 44f3bdcc..d5e21930 100644 --- a/nipyapi/nifi/models/affected_component_dto.py +++ b/nipyapi/nifi/models/affected_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_entity.py b/nipyapi/nifi/models/affected_component_entity.py index 42aeb358..213556ec 100644 --- a/nipyapi/nifi/models/affected_component_entity.py +++ b/nipyapi/nifi/models/affected_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_dto.py b/nipyapi/nifi/models/allowable_value_dto.py index a79cc4d2..2ab2d7ce 100644 --- a/nipyapi/nifi/models/allowable_value_dto.py +++ b/nipyapi/nifi/models/allowable_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_entity.py b/nipyapi/nifi/models/allowable_value_entity.py index 137c28a6..9f8decd1 100644 --- a/nipyapi/nifi/models/allowable_value_entity.py +++ b/nipyapi/nifi/models/allowable_value_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/attribute_dto.py b/nipyapi/nifi/models/attribute_dto.py index 7153864b..b8113672 100644 --- a/nipyapi/nifi/models/attribute_dto.py +++ b/nipyapi/nifi/models/attribute_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_dto.py b/nipyapi/nifi/models/banner_dto.py index b90bc3e5..18f30355 100644 --- a/nipyapi/nifi/models/banner_dto.py +++ b/nipyapi/nifi/models/banner_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_entity.py b/nipyapi/nifi/models/banner_entity.py index b4e829c8..00121dc0 100644 --- a/nipyapi/nifi/models/banner_entity.py +++ b/nipyapi/nifi/models/banner_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_settings_dto.py b/nipyapi/nifi/models/batch_settings_dto.py index 3ce67048..96301d3f 100644 --- a/nipyapi/nifi/models/batch_settings_dto.py +++ b/nipyapi/nifi/models/batch_settings_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_size.py b/nipyapi/nifi/models/batch_size.py index c65afad6..a41dd157 100644 --- a/nipyapi/nifi/models/batch_size.py +++ b/nipyapi/nifi/models/batch_size.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket.py b/nipyapi/nifi/models/bucket.py index f069677d..bb89a549 100644 --- a/nipyapi/nifi/models/bucket.py +++ b/nipyapi/nifi/models/bucket.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket_dto.py b/nipyapi/nifi/models/bucket_dto.py index a5c266ea..36f4fc52 100644 --- a/nipyapi/nifi/models/bucket_dto.py +++ b/nipyapi/nifi/models/bucket_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket_entity.py b/nipyapi/nifi/models/bucket_entity.py index 05a97281..78214122 100644 --- a/nipyapi/nifi/models/bucket_entity.py +++ b/nipyapi/nifi/models/bucket_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/buckets_entity.py b/nipyapi/nifi/models/buckets_entity.py index a85ca054..d06480bd 100644 --- a/nipyapi/nifi/models/buckets_entity.py +++ b/nipyapi/nifi/models/buckets_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_dto.py b/nipyapi/nifi/models/bulletin_board_dto.py index c82ad8f7..41f1fb78 100644 --- a/nipyapi/nifi/models/bulletin_board_dto.py +++ b/nipyapi/nifi/models/bulletin_board_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_entity.py b/nipyapi/nifi/models/bulletin_board_entity.py index 8b0437b8..2f2c1552 100644 --- a/nipyapi/nifi/models/bulletin_board_entity.py +++ b/nipyapi/nifi/models/bulletin_board_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_dto.py b/nipyapi/nifi/models/bulletin_dto.py index 81ae073a..0cf0a10c 100644 --- a/nipyapi/nifi/models/bulletin_dto.py +++ b/nipyapi/nifi/models/bulletin_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_entity.py b/nipyapi/nifi/models/bulletin_entity.py index c7dfacac..08fdb922 100644 --- a/nipyapi/nifi/models/bulletin_entity.py +++ b/nipyapi/nifi/models/bulletin_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle.py b/nipyapi/nifi/models/bundle.py index 23cdc89d..ec3e6864 100644 --- a/nipyapi/nifi/models/bundle.py +++ b/nipyapi/nifi/models/bundle.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle_dto.py b/nipyapi/nifi/models/bundle_dto.py index dc3d7745..a8d98581 100644 --- a/nipyapi/nifi/models/bundle_dto.py +++ b/nipyapi/nifi/models/bundle_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluste_summary_entity.py b/nipyapi/nifi/models/cluste_summary_entity.py index 8143865a..0ea638e2 100644 --- a/nipyapi/nifi/models/cluste_summary_entity.py +++ b/nipyapi/nifi/models/cluste_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_dto.py b/nipyapi/nifi/models/cluster_dto.py index 9f46554c..fd44e2ca 100644 --- a/nipyapi/nifi/models/cluster_dto.py +++ b/nipyapi/nifi/models/cluster_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_entity.py b/nipyapi/nifi/models/cluster_entity.py index 8d28abdd..c8fe393d 100644 --- a/nipyapi/nifi/models/cluster_entity.py +++ b/nipyapi/nifi/models/cluster_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_search_results_entity.py b/nipyapi/nifi/models/cluster_search_results_entity.py index 55088a1e..99b7dfe5 100644 --- a/nipyapi/nifi/models/cluster_search_results_entity.py +++ b/nipyapi/nifi/models/cluster_search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_summary_dto.py b/nipyapi/nifi/models/cluster_summary_dto.py index 24e30bf1..8c5c0fde 100644 --- a/nipyapi/nifi/models/cluster_summary_dto.py +++ b/nipyapi/nifi/models/cluster_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_details_dto.py b/nipyapi/nifi/models/component_details_dto.py index fb4730a7..c4dc085a 100644 --- a/nipyapi/nifi/models/component_details_dto.py +++ b/nipyapi/nifi/models/component_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_difference_dto.py b/nipyapi/nifi/models/component_difference_dto.py index cb8dad5d..d8a34928 100644 --- a/nipyapi/nifi/models/component_difference_dto.py +++ b/nipyapi/nifi/models/component_difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_dto.py b/nipyapi/nifi/models/component_history_dto.py index 2b7cc956..ce6fd8cd 100644 --- a/nipyapi/nifi/models/component_history_dto.py +++ b/nipyapi/nifi/models/component_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_entity.py b/nipyapi/nifi/models/component_history_entity.py index 75945e31..04579d58 100644 --- a/nipyapi/nifi/models/component_history_entity.py +++ b/nipyapi/nifi/models/component_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_dto.py b/nipyapi/nifi/models/component_reference_dto.py index 1015c76c..fe8bdc05 100644 --- a/nipyapi/nifi/models/component_reference_dto.py +++ b/nipyapi/nifi/models/component_reference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_entity.py b/nipyapi/nifi/models/component_reference_entity.py index 020b7533..65f3e6ce 100644 --- a/nipyapi/nifi/models/component_reference_entity.py +++ b/nipyapi/nifi/models/component_reference_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_restriction_permission_dto.py b/nipyapi/nifi/models/component_restriction_permission_dto.py index a27a5f87..2853da4c 100644 --- a/nipyapi/nifi/models/component_restriction_permission_dto.py +++ b/nipyapi/nifi/models/component_restriction_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_search_result_dto.py b/nipyapi/nifi/models/component_search_result_dto.py index 680af7cf..0b7ce870 100644 --- a/nipyapi/nifi/models/component_search_result_dto.py +++ b/nipyapi/nifi/models/component_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_dto.py b/nipyapi/nifi/models/component_state_dto.py index cd52e813..73530472 100644 --- a/nipyapi/nifi/models/component_state_dto.py +++ b/nipyapi/nifi/models/component_state_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_entity.py b/nipyapi/nifi/models/component_state_entity.py index b77c7b09..24c64d77 100644 --- a/nipyapi/nifi/models/component_state_entity.py +++ b/nipyapi/nifi/models/component_state_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_dto.py b/nipyapi/nifi/models/component_validation_result_dto.py index fff661f5..67cfa91e 100644 --- a/nipyapi/nifi/models/component_validation_result_dto.py +++ b/nipyapi/nifi/models/component_validation_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_entity.py b/nipyapi/nifi/models/component_validation_result_entity.py index 71630e71..a1a61118 100644 --- a/nipyapi/nifi/models/component_validation_result_entity.py +++ b/nipyapi/nifi/models/component_validation_result_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_results_entity.py b/nipyapi/nifi/models/component_validation_results_entity.py index 70a64faf..aa51d977 100644 --- a/nipyapi/nifi/models/component_validation_results_entity.py +++ b/nipyapi/nifi/models/component_validation_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_component.py b/nipyapi/nifi/models/connectable_component.py index ee49dcc6..dc434e13 100644 --- a/nipyapi/nifi/models/connectable_component.py +++ b/nipyapi/nifi/models/connectable_component.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_dto.py b/nipyapi/nifi/models/connectable_dto.py index 72cbc9dd..14d0b65d 100644 --- a/nipyapi/nifi/models/connectable_dto.py +++ b/nipyapi/nifi/models/connectable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_dto.py b/nipyapi/nifi/models/connection_dto.py index 15d5e001..0a496678 100644 --- a/nipyapi/nifi/models/connection_dto.py +++ b/nipyapi/nifi/models/connection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_entity.py b/nipyapi/nifi/models/connection_entity.py index c48cd824..b1e8635d 100644 --- a/nipyapi/nifi/models/connection_entity.py +++ b/nipyapi/nifi/models/connection_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_dto.py b/nipyapi/nifi/models/connection_statistics_dto.py index 2003b318..cea241f3 100644 --- a/nipyapi/nifi/models/connection_statistics_dto.py +++ b/nipyapi/nifi/models/connection_statistics_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_entity.py b/nipyapi/nifi/models/connection_statistics_entity.py index cd6a18d5..fa1683ac 100644 --- a/nipyapi/nifi/models/connection_statistics_entity.py +++ b/nipyapi/nifi/models/connection_statistics_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py index 98524fec..6d51db4b 100644 --- a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_dto.py b/nipyapi/nifi/models/connection_status_dto.py index 81a5bffa..8a745015 100644 --- a/nipyapi/nifi/models/connection_status_dto.py +++ b/nipyapi/nifi/models/connection_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_entity.py b/nipyapi/nifi/models/connection_status_entity.py index 78a92039..58a35de1 100644 --- a/nipyapi/nifi/models/connection_status_entity.py +++ b/nipyapi/nifi/models/connection_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py index b0f0c195..81c8bbad 100644 --- a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_dto.py b/nipyapi/nifi/models/connection_status_snapshot_dto.py index 69cf8c94..453ba392 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_entity.py b/nipyapi/nifi/models/connection_status_snapshot_entity.py index efc4d104..3a3f6cce 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_entity.py +++ b/nipyapi/nifi/models/connection_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connections_entity.py b/nipyapi/nifi/models/connections_entity.py index 6c4dc8c2..dd31e906 100644 --- a/nipyapi/nifi/models/connections_entity.py +++ b/nipyapi/nifi/models/connections_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_bulletins_entity.py b/nipyapi/nifi/models/controller_bulletins_entity.py index 91d1279b..6128651f 100644 --- a/nipyapi/nifi/models/controller_bulletins_entity.py +++ b/nipyapi/nifi/models/controller_bulletins_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_dto.py b/nipyapi/nifi/models/controller_configuration_dto.py index 7f9027b8..90257ff5 100644 --- a/nipyapi/nifi/models/controller_configuration_dto.py +++ b/nipyapi/nifi/models/controller_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_entity.py b/nipyapi/nifi/models/controller_configuration_entity.py index bcdf8057..460b7621 100644 --- a/nipyapi/nifi/models/controller_configuration_entity.py +++ b/nipyapi/nifi/models/controller_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_dto.py b/nipyapi/nifi/models/controller_dto.py index a6323e65..e3f8762b 100644 --- a/nipyapi/nifi/models/controller_dto.py +++ b/nipyapi/nifi/models/controller_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_entity.py b/nipyapi/nifi/models/controller_entity.py index 6b0425a5..8a7680ec 100644 --- a/nipyapi/nifi/models/controller_entity.py +++ b/nipyapi/nifi/models/controller_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api.py b/nipyapi/nifi/models/controller_service_api.py index 2f65f9c2..3bf1a937 100644 --- a/nipyapi/nifi/models/controller_service_api.py +++ b/nipyapi/nifi/models/controller_service_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api_dto.py b/nipyapi/nifi/models/controller_service_api_dto.py index df3949db..7ee5cd93 100644 --- a/nipyapi/nifi/models/controller_service_api_dto.py +++ b/nipyapi/nifi/models/controller_service_api_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_dto.py b/nipyapi/nifi/models/controller_service_dto.py index 03b73ce1..5ad3d253 100644 --- a/nipyapi/nifi/models/controller_service_dto.py +++ b/nipyapi/nifi/models/controller_service_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_entity.py b/nipyapi/nifi/models/controller_service_entity.py index 67a556da..d9dc5b67 100644 --- a/nipyapi/nifi/models/controller_service_entity.py +++ b/nipyapi/nifi/models/controller_service_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index 0e8d9be1..e8beffcc 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_entity.py b/nipyapi/nifi/models/controller_service_referencing_component_entity.py index 97f99368..df644f11 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_components_entity.py b/nipyapi/nifi/models/controller_service_referencing_components_entity.py index 8e64ba56..7503ee8e 100644 --- a/nipyapi/nifi/models/controller_service_referencing_components_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_run_status_entity.py b/nipyapi/nifi/models/controller_service_run_status_entity.py index bf397a0f..f5b7964f 100644 --- a/nipyapi/nifi/models/controller_service_run_status_entity.py +++ b/nipyapi/nifi/models/controller_service_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_status_dto.py b/nipyapi/nifi/models/controller_service_status_dto.py index 29e5f2e5..f7c3e253 100644 --- a/nipyapi/nifi/models/controller_service_status_dto.py +++ b/nipyapi/nifi/models/controller_service_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_types_entity.py b/nipyapi/nifi/models/controller_service_types_entity.py index acd601f2..5fc7a793 100644 --- a/nipyapi/nifi/models/controller_service_types_entity.py +++ b/nipyapi/nifi/models/controller_service_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_services_entity.py b/nipyapi/nifi/models/controller_services_entity.py index b7808043..c92b906a 100644 --- a/nipyapi/nifi/models/controller_services_entity.py +++ b/nipyapi/nifi/models/controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_dto.py b/nipyapi/nifi/models/controller_status_dto.py index f7080ea2..3a521c36 100644 --- a/nipyapi/nifi/models/controller_status_dto.py +++ b/nipyapi/nifi/models/controller_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_entity.py b/nipyapi/nifi/models/controller_status_entity.py index 0e4f3ea8..37d55a04 100644 --- a/nipyapi/nifi/models/controller_status_entity.py +++ b/nipyapi/nifi/models/controller_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/copy_snippet_request_entity.py b/nipyapi/nifi/models/copy_snippet_request_entity.py index 65f2161c..6ce0062d 100644 --- a/nipyapi/nifi/models/copy_snippet_request_entity.py +++ b/nipyapi/nifi/models/copy_snippet_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_dto.py b/nipyapi/nifi/models/counter_dto.py index 1599c822..6dd70eca 100644 --- a/nipyapi/nifi/models/counter_dto.py +++ b/nipyapi/nifi/models/counter_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_entity.py b/nipyapi/nifi/models/counter_entity.py index 283a01fc..b09fa3c4 100644 --- a/nipyapi/nifi/models/counter_entity.py +++ b/nipyapi/nifi/models/counter_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_dto.py b/nipyapi/nifi/models/counters_dto.py index bf53305c..19525e0c 100644 --- a/nipyapi/nifi/models/counters_dto.py +++ b/nipyapi/nifi/models/counters_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_entity.py b/nipyapi/nifi/models/counters_entity.py index 5b654a09..dae8ee72 100644 --- a/nipyapi/nifi/models/counters_entity.py +++ b/nipyapi/nifi/models/counters_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_snapshot_dto.py b/nipyapi/nifi/models/counters_snapshot_dto.py index fc3e5c15..0b33ab9d 100644 --- a/nipyapi/nifi/models/counters_snapshot_dto.py +++ b/nipyapi/nifi/models/counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_active_request_entity.py b/nipyapi/nifi/models/create_active_request_entity.py index 4ed96bb0..e79e89b6 100644 --- a/nipyapi/nifi/models/create_active_request_entity.py +++ b/nipyapi/nifi/models/create_active_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_template_request_entity.py b/nipyapi/nifi/models/create_template_request_entity.py index 0cce1072..febc4161 100644 --- a/nipyapi/nifi/models/create_template_request_entity.py +++ b/nipyapi/nifi/models/create_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/current_user_entity.py b/nipyapi/nifi/models/current_user_entity.py index 3c821993..09d2e135 100644 --- a/nipyapi/nifi/models/current_user_entity.py +++ b/nipyapi/nifi/models/current_user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/difference_dto.py b/nipyapi/nifi/models/difference_dto.py index 3fe97fd8..ada45412 100644 --- a/nipyapi/nifi/models/difference_dto.py +++ b/nipyapi/nifi/models/difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dimensions_dto.py b/nipyapi/nifi/models/dimensions_dto.py index 41cbce0d..db96369a 100644 --- a/nipyapi/nifi/models/dimensions_dto.py +++ b/nipyapi/nifi/models/dimensions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/documented_type_dto.py b/nipyapi/nifi/models/documented_type_dto.py index 231134ec..417ede00 100644 --- a/nipyapi/nifi/models/documented_type_dto.py +++ b/nipyapi/nifi/models/documented_type_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_dto.py b/nipyapi/nifi/models/drop_request_dto.py index 250e4077..5341366b 100644 --- a/nipyapi/nifi/models/drop_request_dto.py +++ b/nipyapi/nifi/models/drop_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_entity.py b/nipyapi/nifi/models/drop_request_entity.py index cc3f3df7..731011b9 100644 --- a/nipyapi/nifi/models/drop_request_entity.py +++ b/nipyapi/nifi/models/drop_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/explicit_restriction_dto.py b/nipyapi/nifi/models/explicit_restriction_dto.py index c42d27e9..61f41e07 100644 --- a/nipyapi/nifi/models/explicit_restriction_dto.py +++ b/nipyapi/nifi/models/explicit_restriction_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/external_controller_service_reference.py b/nipyapi/nifi/models/external_controller_service_reference.py index 54689294..4869e2e7 100644 --- a/nipyapi/nifi/models/external_controller_service_reference.py +++ b/nipyapi/nifi/models/external_controller_service_reference.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_dto.py b/nipyapi/nifi/models/flow_breadcrumb_dto.py index 4bb3fccc..6874b8a4 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_dto.py +++ b/nipyapi/nifi/models/flow_breadcrumb_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_entity.py b/nipyapi/nifi/models/flow_breadcrumb_entity.py index 37ece9f9..eac2b362 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_entity.py +++ b/nipyapi/nifi/models/flow_breadcrumb_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_comparison_entity.py b/nipyapi/nifi/models/flow_comparison_entity.py index 6ffc4b10..eb3d4eba 100644 --- a/nipyapi/nifi/models/flow_comparison_entity.py +++ b/nipyapi/nifi/models/flow_comparison_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_dto.py b/nipyapi/nifi/models/flow_configuration_dto.py index df9fd085..5d67a1a1 100644 --- a/nipyapi/nifi/models/flow_configuration_dto.py +++ b/nipyapi/nifi/models/flow_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_entity.py b/nipyapi/nifi/models/flow_configuration_entity.py index 0ad226de..d7682fce 100644 --- a/nipyapi/nifi/models/flow_configuration_entity.py +++ b/nipyapi/nifi/models/flow_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_dto.py b/nipyapi/nifi/models/flow_dto.py index 60d28e3e..acecdb43 100644 --- a/nipyapi/nifi/models/flow_dto.py +++ b/nipyapi/nifi/models/flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_entity.py b/nipyapi/nifi/models/flow_entity.py index d67c0175..62ab08b5 100644 --- a/nipyapi/nifi/models/flow_entity.py +++ b/nipyapi/nifi/models/flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_dto.py b/nipyapi/nifi/models/flow_file_dto.py index f4da0192..f94c45cf 100644 --- a/nipyapi/nifi/models/flow_file_dto.py +++ b/nipyapi/nifi/models/flow_file_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_entity.py b/nipyapi/nifi/models/flow_file_entity.py index c801cb97..810d5dcf 100644 --- a/nipyapi/nifi/models/flow_file_entity.py +++ b/nipyapi/nifi/models/flow_file_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_summary_dto.py b/nipyapi/nifi/models/flow_file_summary_dto.py index 1cafbdfd..974b2b6f 100644 --- a/nipyapi/nifi/models/flow_file_summary_dto.py +++ b/nipyapi/nifi/models/flow_file_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_snippet_dto.py b/nipyapi/nifi/models/flow_snippet_dto.py index 335180df..137faf14 100644 --- a/nipyapi/nifi/models/flow_snippet_dto.py +++ b/nipyapi/nifi/models/flow_snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_dto.py b/nipyapi/nifi/models/funnel_dto.py index b68d495c..07683243 100644 --- a/nipyapi/nifi/models/funnel_dto.py +++ b/nipyapi/nifi/models/funnel_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_entity.py b/nipyapi/nifi/models/funnel_entity.py index 3594cc5d..e7218b1d 100644 --- a/nipyapi/nifi/models/funnel_entity.py +++ b/nipyapi/nifi/models/funnel_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnels_entity.py b/nipyapi/nifi/models/funnels_entity.py index 76031142..2c1b5b4f 100644 --- a/nipyapi/nifi/models/funnels_entity.py +++ b/nipyapi/nifi/models/funnels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/garbage_collection_dto.py b/nipyapi/nifi/models/garbage_collection_dto.py index ad92cbd3..886821b3 100644 --- a/nipyapi/nifi/models/garbage_collection_dto.py +++ b/nipyapi/nifi/models/garbage_collection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_dto.py b/nipyapi/nifi/models/history_dto.py index 8af6f1f1..602656a6 100644 --- a/nipyapi/nifi/models/history_dto.py +++ b/nipyapi/nifi/models/history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_entity.py b/nipyapi/nifi/models/history_entity.py index ed06f473..3516fa0b 100644 --- a/nipyapi/nifi/models/history_entity.py +++ b/nipyapi/nifi/models/history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/input_ports_entity.py b/nipyapi/nifi/models/input_ports_entity.py index 1bb7048d..d3b1bdbf 100644 --- a/nipyapi/nifi/models/input_ports_entity.py +++ b/nipyapi/nifi/models/input_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/instantiate_template_request_entity.py b/nipyapi/nifi/models/instantiate_template_request_entity.py index a1c39649..e52353c7 100644 --- a/nipyapi/nifi/models/instantiate_template_request_entity.py +++ b/nipyapi/nifi/models/instantiate_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jaxb_link.py b/nipyapi/nifi/models/jaxb_link.py index 03acc670..804a716b 100644 --- a/nipyapi/nifi/models/jaxb_link.py +++ b/nipyapi/nifi/models/jaxb_link.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_dto.py b/nipyapi/nifi/models/label_dto.py index e64b0090..4382ff65 100644 --- a/nipyapi/nifi/models/label_dto.py +++ b/nipyapi/nifi/models/label_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_entity.py b/nipyapi/nifi/models/label_entity.py index 36f855b6..6ffb4ee3 100644 --- a/nipyapi/nifi/models/label_entity.py +++ b/nipyapi/nifi/models/label_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/labels_entity.py b/nipyapi/nifi/models/labels_entity.py index 162df91b..3252ce02 100644 --- a/nipyapi/nifi/models/labels_entity.py +++ b/nipyapi/nifi/models/labels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_dto.py b/nipyapi/nifi/models/lineage_dto.py index f42a5672..689612ea 100644 --- a/nipyapi/nifi/models/lineage_dto.py +++ b/nipyapi/nifi/models/lineage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_entity.py b/nipyapi/nifi/models/lineage_entity.py index 88f8d4da..5ed86a3a 100644 --- a/nipyapi/nifi/models/lineage_entity.py +++ b/nipyapi/nifi/models/lineage_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_request_dto.py b/nipyapi/nifi/models/lineage_request_dto.py index bcbb3def..5c6a42b3 100644 --- a/nipyapi/nifi/models/lineage_request_dto.py +++ b/nipyapi/nifi/models/lineage_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_results_dto.py b/nipyapi/nifi/models/lineage_results_dto.py index 48a5df68..b2878964 100644 --- a/nipyapi/nifi/models/lineage_results_dto.py +++ b/nipyapi/nifi/models/lineage_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/listing_request_dto.py b/nipyapi/nifi/models/listing_request_dto.py index 4bf6521e..853a845e 100644 --- a/nipyapi/nifi/models/listing_request_dto.py +++ b/nipyapi/nifi/models/listing_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/listing_request_entity.py b/nipyapi/nifi/models/listing_request_entity.py index e4341608..279c6d86 100644 --- a/nipyapi/nifi/models/listing_request_entity.py +++ b/nipyapi/nifi/models/listing_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py index de6968ba..bbbf721c 100644 --- a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py index 890a1129..95d7f620 100644 --- a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_counters_snapshot_dto.py b/nipyapi/nifi/models/node_counters_snapshot_dto.py index 34f2932c..51a70002 100644 --- a/nipyapi/nifi/models/node_counters_snapshot_dto.py +++ b/nipyapi/nifi/models/node_counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_dto.py b/nipyapi/nifi/models/node_dto.py index bdcad7e2..d617b117 100644 --- a/nipyapi/nifi/models/node_dto.py +++ b/nipyapi/nifi/models/node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_entity.py b/nipyapi/nifi/models/node_entity.py index e18b6f8e..a0bfe490 100644 --- a/nipyapi/nifi/models/node_entity.py +++ b/nipyapi/nifi/models/node_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_event_dto.py b/nipyapi/nifi/models/node_event_dto.py index 7ce20901..796cc0e2 100644 --- a/nipyapi/nifi/models/node_event_dto.py +++ b/nipyapi/nifi/models/node_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_port_status_snapshot_dto.py b/nipyapi/nifi/models/node_port_status_snapshot_dto.py index e5cc20d6..dc059c1b 100644 --- a/nipyapi/nifi/models/node_port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py index 2adb8225..eedfbf0a 100644 --- a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py index 58238a02..eb62aa3c 100644 --- a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py index f4238dab..fb727230 100644 --- a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_search_result_dto.py b/nipyapi/nifi/models/node_search_result_dto.py index 0bb54c11..2a05e600 100644 --- a/nipyapi/nifi/models/node_search_result_dto.py +++ b/nipyapi/nifi/models/node_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_status_snapshots_dto.py b/nipyapi/nifi/models/node_status_snapshots_dto.py index 3f387047..77330319 100644 --- a/nipyapi/nifi/models/node_status_snapshots_dto.py +++ b/nipyapi/nifi/models/node_status_snapshots_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py index d6dacd20..03f56117 100644 --- a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/output_ports_entity.py b/nipyapi/nifi/models/output_ports_entity.py index 87cfe258..15e06705 100644 --- a/nipyapi/nifi/models/output_ports_entity.py +++ b/nipyapi/nifi/models/output_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_dto.py b/nipyapi/nifi/models/parameter_context_dto.py index 782aa577..6f7cb8f9 100644 --- a/nipyapi/nifi/models/parameter_context_dto.py +++ b/nipyapi/nifi/models/parameter_context_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_entity.py b/nipyapi/nifi/models/parameter_context_entity.py index f1e2314a..835aa523 100644 --- a/nipyapi/nifi/models/parameter_context_entity.py +++ b/nipyapi/nifi/models/parameter_context_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_reference_dto.py b/nipyapi/nifi/models/parameter_context_reference_dto.py index 8d5a0733..e68e61b2 100644 --- a/nipyapi/nifi/models/parameter_context_reference_dto.py +++ b/nipyapi/nifi/models/parameter_context_reference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_reference_entity.py b/nipyapi/nifi/models/parameter_context_reference_entity.py index d8ccf495..354386af 100644 --- a/nipyapi/nifi/models/parameter_context_reference_entity.py +++ b/nipyapi/nifi/models/parameter_context_reference_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_dto.py b/nipyapi/nifi/models/parameter_context_update_request_dto.py index d48faac7..48520c5f 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_entity.py b/nipyapi/nifi/models/parameter_context_update_request_entity.py index a980f1ac..44142551 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_step_dto.py b/nipyapi/nifi/models/parameter_context_update_step_dto.py index 9ccc5f4a..eb1ec9ed 100644 --- a/nipyapi/nifi/models/parameter_context_update_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_dto.py b/nipyapi/nifi/models/parameter_context_validation_request_dto.py index 18dba560..f8781b7d 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_entity.py b/nipyapi/nifi/models/parameter_context_validation_request_entity.py index cc35a2fb..b5b9c6c2 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_step_dto.py b/nipyapi/nifi/models/parameter_context_validation_step_dto.py index 82bb1b12..01fd769e 100644 --- a/nipyapi/nifi/models/parameter_context_validation_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_contexts_entity.py b/nipyapi/nifi/models/parameter_contexts_entity.py index f90bc94c..4af00b29 100644 --- a/nipyapi/nifi/models/parameter_contexts_entity.py +++ b/nipyapi/nifi/models/parameter_contexts_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_dto.py b/nipyapi/nifi/models/parameter_dto.py index 9ddc80d7..10c59f0b 100644 --- a/nipyapi/nifi/models/parameter_dto.py +++ b/nipyapi/nifi/models/parameter_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_entity.py b/nipyapi/nifi/models/parameter_entity.py index ca0bdc72..d72acbb6 100644 --- a/nipyapi/nifi/models/parameter_entity.py +++ b/nipyapi/nifi/models/parameter_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peer_dto.py b/nipyapi/nifi/models/peer_dto.py index 4125fc87..a7894526 100644 --- a/nipyapi/nifi/models/peer_dto.py +++ b/nipyapi/nifi/models/peer_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peers_entity.py b/nipyapi/nifi/models/peers_entity.py index b87f6a1f..acca895a 100644 --- a/nipyapi/nifi/models/peers_entity.py +++ b/nipyapi/nifi/models/peers_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions.py b/nipyapi/nifi/models/permissions.py index 5b078121..c8ff2871 100644 --- a/nipyapi/nifi/models/permissions.py +++ b/nipyapi/nifi/models/permissions.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions_dto.py b/nipyapi/nifi/models/permissions_dto.py index eafa7e9d..60a99ee1 100644 --- a/nipyapi/nifi/models/permissions_dto.py +++ b/nipyapi/nifi/models/permissions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_dto.py b/nipyapi/nifi/models/port_dto.py index 9f2685a6..e814b456 100644 --- a/nipyapi/nifi/models/port_dto.py +++ b/nipyapi/nifi/models/port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_entity.py b/nipyapi/nifi/models/port_entity.py index af3b8d5b..eda1695e 100644 --- a/nipyapi/nifi/models/port_entity.py +++ b/nipyapi/nifi/models/port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_run_status_entity.py b/nipyapi/nifi/models/port_run_status_entity.py index efdc6040..bab6d952 100644 --- a/nipyapi/nifi/models/port_run_status_entity.py +++ b/nipyapi/nifi/models/port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_dto.py b/nipyapi/nifi/models/port_status_dto.py index 92a0d5e0..eac5f8ae 100644 --- a/nipyapi/nifi/models/port_status_dto.py +++ b/nipyapi/nifi/models/port_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_entity.py b/nipyapi/nifi/models/port_status_entity.py index adc7c9f2..e608ff8f 100644 --- a/nipyapi/nifi/models/port_status_entity.py +++ b/nipyapi/nifi/models/port_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_dto.py b/nipyapi/nifi/models/port_status_snapshot_dto.py index f9e9aea5..131ef238 100644 --- a/nipyapi/nifi/models/port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_entity.py b/nipyapi/nifi/models/port_status_snapshot_entity.py index c021e925..c6af4fc4 100644 --- a/nipyapi/nifi/models/port_status_snapshot_entity.py +++ b/nipyapi/nifi/models/port_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position.py b/nipyapi/nifi/models/position.py index c6ae7b92..0f7bbaf9 100644 --- a/nipyapi/nifi/models/position.py +++ b/nipyapi/nifi/models/position.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position_dto.py b/nipyapi/nifi/models/position_dto.py index b7a1ffb1..1a39eb72 100644 --- a/nipyapi/nifi/models/position_dto.py +++ b/nipyapi/nifi/models/position_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/previous_value_dto.py b/nipyapi/nifi/models/previous_value_dto.py index ae46d106..ca41853d 100644 --- a/nipyapi/nifi/models/previous_value_dto.py +++ b/nipyapi/nifi/models/previous_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/prioritizer_types_entity.py b/nipyapi/nifi/models/prioritizer_types_entity.py index 9ddbea7b..42f1383d 100644 --- a/nipyapi/nifi/models/prioritizer_types_entity.py +++ b/nipyapi/nifi/models/prioritizer_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_dto.py b/nipyapi/nifi/models/process_group_dto.py index 58745f54..404ed6eb 100644 --- a/nipyapi/nifi/models/process_group_dto.py +++ b/nipyapi/nifi/models/process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_entity.py b/nipyapi/nifi/models/process_group_entity.py index 7de62677..45b946af 100644 --- a/nipyapi/nifi/models/process_group_entity.py +++ b/nipyapi/nifi/models/process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_flow_dto.py b/nipyapi/nifi/models/process_group_flow_dto.py index d99ae92a..2301720a 100644 --- a/nipyapi/nifi/models/process_group_flow_dto.py +++ b/nipyapi/nifi/models/process_group_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_flow_entity.py b/nipyapi/nifi/models/process_group_flow_entity.py index 20c8be40..9fa3549b 100644 --- a/nipyapi/nifi/models/process_group_flow_entity.py +++ b/nipyapi/nifi/models/process_group_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_name_dto.py b/nipyapi/nifi/models/process_group_name_dto.py index 769f3757..dad2aec9 100644 --- a/nipyapi/nifi/models/process_group_name_dto.py +++ b/nipyapi/nifi/models/process_group_name_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_dto.py b/nipyapi/nifi/models/process_group_status_dto.py index df51175a..4d6b1eec 100644 --- a/nipyapi/nifi/models/process_group_status_dto.py +++ b/nipyapi/nifi/models/process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_entity.py b/nipyapi/nifi/models/process_group_status_entity.py index f46e4de3..322f4cc2 100644 --- a/nipyapi/nifi/models/process_group_status_entity.py +++ b/nipyapi/nifi/models/process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_dto.py b/nipyapi/nifi/models/process_group_status_snapshot_dto.py index 844e6e2e..858af104 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_entity.py b/nipyapi/nifi/models/process_group_status_snapshot_entity.py index 06099445..b07a66b3 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_groups_entity.py b/nipyapi/nifi/models/process_groups_entity.py index f542f916..c4d8aaeb 100644 --- a/nipyapi/nifi/models/process_groups_entity.py +++ b/nipyapi/nifi/models/process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_config_dto.py b/nipyapi/nifi/models/processor_config_dto.py index aac75c74..33e6fa7c 100644 --- a/nipyapi/nifi/models/processor_config_dto.py +++ b/nipyapi/nifi/models/processor_config_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_dto.py b/nipyapi/nifi/models/processor_dto.py index 22288d8a..1479a482 100644 --- a/nipyapi/nifi/models/processor_dto.py +++ b/nipyapi/nifi/models/processor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_entity.py b/nipyapi/nifi/models/processor_entity.py index 5abf2de7..f5f97e72 100644 --- a/nipyapi/nifi/models/processor_entity.py +++ b/nipyapi/nifi/models/processor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_run_status_entity.py b/nipyapi/nifi/models/processor_run_status_entity.py index d9d5f0e1..663ea33d 100644 --- a/nipyapi/nifi/models/processor_run_status_entity.py +++ b/nipyapi/nifi/models/processor_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_dto.py b/nipyapi/nifi/models/processor_status_dto.py index 19b8049d..f395b084 100644 --- a/nipyapi/nifi/models/processor_status_dto.py +++ b/nipyapi/nifi/models/processor_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_entity.py b/nipyapi/nifi/models/processor_status_entity.py index 9a38953f..dfb9b0f1 100644 --- a/nipyapi/nifi/models/processor_status_entity.py +++ b/nipyapi/nifi/models/processor_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_dto.py b/nipyapi/nifi/models/processor_status_snapshot_dto.py index 5488e91e..679d208d 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_entity.py b/nipyapi/nifi/models/processor_status_snapshot_entity.py index fe7c0ce4..d6d9440f 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_entity.py +++ b/nipyapi/nifi/models/processor_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_types_entity.py b/nipyapi/nifi/models/processor_types_entity.py index 2a29682f..54a8fb0d 100644 --- a/nipyapi/nifi/models/processor_types_entity.py +++ b/nipyapi/nifi/models/processor_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processors_entity.py b/nipyapi/nifi/models/processors_entity.py index 1f38a11a..d4502703 100644 --- a/nipyapi/nifi/models/processors_entity.py +++ b/nipyapi/nifi/models/processors_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_dto.py b/nipyapi/nifi/models/property_descriptor_dto.py index 75c7a2a0..21f70dec 100644 --- a/nipyapi/nifi/models/property_descriptor_dto.py +++ b/nipyapi/nifi/models/property_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_entity.py b/nipyapi/nifi/models/property_descriptor_entity.py index 8feb21ba..9b5c2cce 100644 --- a/nipyapi/nifi/models/property_descriptor_entity.py +++ b/nipyapi/nifi/models/property_descriptor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_history_dto.py b/nipyapi/nifi/models/property_history_dto.py index 452bc4aa..0b8476b2 100644 --- a/nipyapi/nifi/models/property_history_dto.py +++ b/nipyapi/nifi/models/property_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_dto.py b/nipyapi/nifi/models/provenance_dto.py index d2b54322..171ad45d 100644 --- a/nipyapi/nifi/models/provenance_dto.py +++ b/nipyapi/nifi/models/provenance_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_entity.py b/nipyapi/nifi/models/provenance_entity.py index 3452a681..0e8a323e 100644 --- a/nipyapi/nifi/models/provenance_entity.py +++ b/nipyapi/nifi/models/provenance_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_dto.py b/nipyapi/nifi/models/provenance_event_dto.py index 11f7c112..e8da3df0 100644 --- a/nipyapi/nifi/models/provenance_event_dto.py +++ b/nipyapi/nifi/models/provenance_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_entity.py b/nipyapi/nifi/models/provenance_event_entity.py index 5f077a8f..d5af4c68 100644 --- a/nipyapi/nifi/models/provenance_event_entity.py +++ b/nipyapi/nifi/models/provenance_event_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_link_dto.py b/nipyapi/nifi/models/provenance_link_dto.py index 1d6e1b1d..2ca1f868 100644 --- a/nipyapi/nifi/models/provenance_link_dto.py +++ b/nipyapi/nifi/models/provenance_link_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_node_dto.py b/nipyapi/nifi/models/provenance_node_dto.py index c10f1690..32bf2409 100644 --- a/nipyapi/nifi/models/provenance_node_dto.py +++ b/nipyapi/nifi/models/provenance_node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_dto.py b/nipyapi/nifi/models/provenance_options_dto.py index 61960d32..2ecb5890 100644 --- a/nipyapi/nifi/models/provenance_options_dto.py +++ b/nipyapi/nifi/models/provenance_options_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_entity.py b/nipyapi/nifi/models/provenance_options_entity.py index 11515a72..e78c0449 100644 --- a/nipyapi/nifi/models/provenance_options_entity.py +++ b/nipyapi/nifi/models/provenance_options_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_request_dto.py b/nipyapi/nifi/models/provenance_request_dto.py index 7c89f8f4..648e75e5 100644 --- a/nipyapi/nifi/models/provenance_request_dto.py +++ b/nipyapi/nifi/models/provenance_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_results_dto.py b/nipyapi/nifi/models/provenance_results_dto.py index 4c149b9c..993db53f 100644 --- a/nipyapi/nifi/models/provenance_results_dto.py +++ b/nipyapi/nifi/models/provenance_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_searchable_field_dto.py b/nipyapi/nifi/models/provenance_searchable_field_dto.py index bf004b3c..bcde8585 100644 --- a/nipyapi/nifi/models/provenance_searchable_field_dto.py +++ b/nipyapi/nifi/models/provenance_searchable_field_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/queue_size_dto.py b/nipyapi/nifi/models/queue_size_dto.py index 22e28a13..d9c4e760 100644 --- a/nipyapi/nifi/models/queue_size_dto.py +++ b/nipyapi/nifi/models/queue_size_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_client_entity.py b/nipyapi/nifi/models/registry_client_entity.py index 7988a9ef..04e5cb3a 100644 --- a/nipyapi/nifi/models/registry_client_entity.py +++ b/nipyapi/nifi/models/registry_client_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_clients_entity.py b/nipyapi/nifi/models/registry_clients_entity.py index b2172920..6f3b99ba 100644 --- a/nipyapi/nifi/models/registry_clients_entity.py +++ b/nipyapi/nifi/models/registry_clients_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_dto.py b/nipyapi/nifi/models/registry_dto.py index 860a8856..f410c1a9 100644 --- a/nipyapi/nifi/models/registry_dto.py +++ b/nipyapi/nifi/models/registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/relationship_dto.py b/nipyapi/nifi/models/relationship_dto.py index be415f73..f14c340e 100644 --- a/nipyapi/nifi/models/relationship_dto.py +++ b/nipyapi/nifi/models/relationship_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_port_run_status_entity.py b/nipyapi/nifi/models/remote_port_run_status_entity.py index 846ae1ce..e42773cf 100644 --- a/nipyapi/nifi/models/remote_port_run_status_entity.py +++ b/nipyapi/nifi/models/remote_port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_contents_dto.py b/nipyapi/nifi/models/remote_process_group_contents_dto.py index cab77a69..ce115c28 100644 --- a/nipyapi/nifi/models/remote_process_group_contents_dto.py +++ b/nipyapi/nifi/models/remote_process_group_contents_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_dto.py b/nipyapi/nifi/models/remote_process_group_dto.py index bf48de30..454be072 100644 --- a/nipyapi/nifi/models/remote_process_group_dto.py +++ b/nipyapi/nifi/models/remote_process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_entity.py b/nipyapi/nifi/models/remote_process_group_entity.py index b4051cd5..8829bcbe 100644 --- a/nipyapi/nifi/models/remote_process_group_entity.py +++ b/nipyapi/nifi/models/remote_process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_dto.py b/nipyapi/nifi/models/remote_process_group_port_dto.py index f7c44aa0..314d1057 100644 --- a/nipyapi/nifi/models/remote_process_group_port_dto.py +++ b/nipyapi/nifi/models/remote_process_group_port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_entity.py b/nipyapi/nifi/models/remote_process_group_port_entity.py index f8e0bb2a..824cf405 100644 --- a/nipyapi/nifi/models/remote_process_group_port_entity.py +++ b/nipyapi/nifi/models/remote_process_group_port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_dto.py b/nipyapi/nifi/models/remote_process_group_status_dto.py index c44e041c..8d479b82 100644 --- a/nipyapi/nifi/models/remote_process_group_status_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_entity.py b/nipyapi/nifi/models/remote_process_group_status_entity.py index 5052574f..882ea5c4 100644 --- a/nipyapi/nifi/models/remote_process_group_status_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py index 28a75c28..9b3052a1 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py index f69636eb..9bd628dd 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_groups_entity.py b/nipyapi/nifi/models/remote_process_groups_entity.py index cecd9aba..6d37ee7a 100644 --- a/nipyapi/nifi/models/remote_process_groups_entity.py +++ b/nipyapi/nifi/models/remote_process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_dto.py b/nipyapi/nifi/models/reporting_task_dto.py index d5a8a7a2..49619df3 100644 --- a/nipyapi/nifi/models/reporting_task_dto.py +++ b/nipyapi/nifi/models/reporting_task_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_entity.py b/nipyapi/nifi/models/reporting_task_entity.py index 78bb3e20..655ddaaa 100644 --- a/nipyapi/nifi/models/reporting_task_entity.py +++ b/nipyapi/nifi/models/reporting_task_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_run_status_entity.py b/nipyapi/nifi/models/reporting_task_run_status_entity.py index 82d4b7a5..0400ce9b 100644 --- a/nipyapi/nifi/models/reporting_task_run_status_entity.py +++ b/nipyapi/nifi/models/reporting_task_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_status_dto.py b/nipyapi/nifi/models/reporting_task_status_dto.py index f65964c5..ed2b12cd 100644 --- a/nipyapi/nifi/models/reporting_task_status_dto.py +++ b/nipyapi/nifi/models/reporting_task_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_types_entity.py b/nipyapi/nifi/models/reporting_task_types_entity.py index 58f71da0..38463924 100644 --- a/nipyapi/nifi/models/reporting_task_types_entity.py +++ b/nipyapi/nifi/models/reporting_task_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_tasks_entity.py b/nipyapi/nifi/models/reporting_tasks_entity.py index bc39d9a6..bb3ba932 100644 --- a/nipyapi/nifi/models/reporting_tasks_entity.py +++ b/nipyapi/nifi/models/reporting_tasks_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/required_permission_dto.py b/nipyapi/nifi/models/required_permission_dto.py index 55ce5a03..ba4a0bcd 100644 --- a/nipyapi/nifi/models/required_permission_dto.py +++ b/nipyapi/nifi/models/required_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resource_dto.py b/nipyapi/nifi/models/resource_dto.py index 9a37354d..1c7a28d2 100644 --- a/nipyapi/nifi/models/resource_dto.py +++ b/nipyapi/nifi/models/resource_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resources_entity.py b/nipyapi/nifi/models/resources_entity.py index cf0444cd..a8635a05 100644 --- a/nipyapi/nifi/models/resources_entity.py +++ b/nipyapi/nifi/models/resources_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/revision_dto.py b/nipyapi/nifi/models/revision_dto.py index 584d4baa..2d22bcde 100644 --- a/nipyapi/nifi/models/revision_dto.py +++ b/nipyapi/nifi/models/revision_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/schedule_components_entity.py b/nipyapi/nifi/models/schedule_components_entity.py index 2c19bec1..233289b1 100644 --- a/nipyapi/nifi/models/schedule_components_entity.py +++ b/nipyapi/nifi/models/schedule_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_result_group_dto.py b/nipyapi/nifi/models/search_result_group_dto.py index 0fd323cb..630ea168 100644 --- a/nipyapi/nifi/models/search_result_group_dto.py +++ b/nipyapi/nifi/models/search_result_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_results_dto.py b/nipyapi/nifi/models/search_results_dto.py index 088fc9b9..a7c70d46 100644 --- a/nipyapi/nifi/models/search_results_dto.py +++ b/nipyapi/nifi/models/search_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_results_entity.py b/nipyapi/nifi/models/search_results_entity.py index 898f05a6..7773420e 100644 --- a/nipyapi/nifi/models/search_results_entity.py +++ b/nipyapi/nifi/models/search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_dto.py b/nipyapi/nifi/models/snippet_dto.py index 3de52765..085166c3 100644 --- a/nipyapi/nifi/models/snippet_dto.py +++ b/nipyapi/nifi/models/snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_entity.py b/nipyapi/nifi/models/snippet_entity.py index e14ddf1a..fefec194 100644 --- a/nipyapi/nifi/models/snippet_entity.py +++ b/nipyapi/nifi/models/snippet_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/start_version_control_request_entity.py b/nipyapi/nifi/models/start_version_control_request_entity.py index 22f1f5fe..926c1425 100644 --- a/nipyapi/nifi/models/start_version_control_request_entity.py +++ b/nipyapi/nifi/models/start_version_control_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_entry_dto.py b/nipyapi/nifi/models/state_entry_dto.py index ef85d53e..2310596e 100644 --- a/nipyapi/nifi/models/state_entry_dto.py +++ b/nipyapi/nifi/models/state_entry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_map_dto.py b/nipyapi/nifi/models/state_map_dto.py index 8b4d3ffb..309c4494 100644 --- a/nipyapi/nifi/models/state_map_dto.py +++ b/nipyapi/nifi/models/state_map_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_descriptor_dto.py b/nipyapi/nifi/models/status_descriptor_dto.py index 03e03cfe..c125ca24 100644 --- a/nipyapi/nifi/models/status_descriptor_dto.py +++ b/nipyapi/nifi/models/status_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_dto.py b/nipyapi/nifi/models/status_history_dto.py index 77e49798..2d2ac6ec 100644 --- a/nipyapi/nifi/models/status_history_dto.py +++ b/nipyapi/nifi/models/status_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_entity.py b/nipyapi/nifi/models/status_history_entity.py index a44d86ed..2f22a918 100644 --- a/nipyapi/nifi/models/status_history_entity.py +++ b/nipyapi/nifi/models/status_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_snapshot_dto.py b/nipyapi/nifi/models/status_snapshot_dto.py index bb530ba0..d1cf256b 100644 --- a/nipyapi/nifi/models/status_snapshot_dto.py +++ b/nipyapi/nifi/models/status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/storage_usage_dto.py b/nipyapi/nifi/models/storage_usage_dto.py index f056fd40..579f826a 100644 --- a/nipyapi/nifi/models/storage_usage_dto.py +++ b/nipyapi/nifi/models/storage_usage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/streaming_output.py b/nipyapi/nifi/models/streaming_output.py index 1c78e22c..3d15d59e 100644 --- a/nipyapi/nifi/models/streaming_output.py +++ b/nipyapi/nifi/models/streaming_output.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/submit_replay_request_entity.py b/nipyapi/nifi/models/submit_replay_request_entity.py index 5fe85285..888668b1 100644 --- a/nipyapi/nifi/models/submit_replay_request_entity.py +++ b/nipyapi/nifi/models/submit_replay_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_dto.py b/nipyapi/nifi/models/system_diagnostics_dto.py index dd2f57a5..17e5c2a0 100644 --- a/nipyapi/nifi/models/system_diagnostics_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_entity.py b/nipyapi/nifi/models/system_diagnostics_entity.py index 277324c8..6ac10735 100644 --- a/nipyapi/nifi/models/system_diagnostics_entity.py +++ b/nipyapi/nifi/models/system_diagnostics_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py index 15c19574..e6e5b323 100644 --- a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_dto.py b/nipyapi/nifi/models/template_dto.py index 21860da0..3a8cb53e 100644 --- a/nipyapi/nifi/models/template_dto.py +++ b/nipyapi/nifi/models/template_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_entity.py b/nipyapi/nifi/models/template_entity.py index 89eeb656..157afe8c 100644 --- a/nipyapi/nifi/models/template_entity.py +++ b/nipyapi/nifi/models/template_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/templates_entity.py b/nipyapi/nifi/models/templates_entity.py index 2e7427ed..8b09419a 100644 --- a/nipyapi/nifi/models/templates_entity.py +++ b/nipyapi/nifi/models/templates_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_dto.py b/nipyapi/nifi/models/tenant_dto.py index 3f422cef..bf9314cd 100644 --- a/nipyapi/nifi/models/tenant_dto.py +++ b/nipyapi/nifi/models/tenant_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_entity.py b/nipyapi/nifi/models/tenant_entity.py index b36b1fb1..6d0fb464 100644 --- a/nipyapi/nifi/models/tenant_entity.py +++ b/nipyapi/nifi/models/tenant_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenants_entity.py b/nipyapi/nifi/models/tenants_entity.py index 5d22bf6a..559d825c 100644 --- a/nipyapi/nifi/models/tenants_entity.py +++ b/nipyapi/nifi/models/tenants_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/transaction_result_entity.py b/nipyapi/nifi/models/transaction_result_entity.py index f272ee90..4507252e 100644 --- a/nipyapi/nifi/models/transaction_result_entity.py +++ b/nipyapi/nifi/models/transaction_result_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py index 86c190c9..e2c25399 100644 --- a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py +++ b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_dto.py b/nipyapi/nifi/models/user_dto.py index 3fe296e2..e5ab8579 100644 --- a/nipyapi/nifi/models/user_dto.py +++ b/nipyapi/nifi/models/user_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_entity.py b/nipyapi/nifi/models/user_entity.py index b164c99c..868715a2 100644 --- a/nipyapi/nifi/models/user_entity.py +++ b/nipyapi/nifi/models/user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_dto.py b/nipyapi/nifi/models/user_group_dto.py index 20586b59..e6b9053d 100644 --- a/nipyapi/nifi/models/user_group_dto.py +++ b/nipyapi/nifi/models/user_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_entity.py b/nipyapi/nifi/models/user_group_entity.py index f7cc59fd..e92f8b1a 100644 --- a/nipyapi/nifi/models/user_group_entity.py +++ b/nipyapi/nifi/models/user_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_groups_entity.py b/nipyapi/nifi/models/user_groups_entity.py index 10913ec1..52fb0f93 100644 --- a/nipyapi/nifi/models/user_groups_entity.py +++ b/nipyapi/nifi/models/user_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/users_entity.py b/nipyapi/nifi/models/users_entity.py index 1ce9b882..0d838be9 100644 --- a/nipyapi/nifi/models/users_entity.py +++ b/nipyapi/nifi/models/users_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_dto.py b/nipyapi/nifi/models/variable_dto.py index a81874a8..292b5c98 100644 --- a/nipyapi/nifi/models/variable_dto.py +++ b/nipyapi/nifi/models/variable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_entity.py b/nipyapi/nifi/models/variable_entity.py index eac6823d..0e604a84 100644 --- a/nipyapi/nifi/models/variable_entity.py +++ b/nipyapi/nifi/models/variable_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_dto.py b/nipyapi/nifi/models/variable_registry_dto.py index 990432b5..04ccc099 100644 --- a/nipyapi/nifi/models/variable_registry_dto.py +++ b/nipyapi/nifi/models/variable_registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_entity.py b/nipyapi/nifi/models/variable_registry_entity.py index c0e7030f..98b13113 100644 --- a/nipyapi/nifi/models/variable_registry_entity.py +++ b/nipyapi/nifi/models/variable_registry_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_dto.py b/nipyapi/nifi/models/variable_registry_update_request_dto.py index 01226e23..1c2d3fd9 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_entity.py b/nipyapi/nifi/models/variable_registry_update_request_entity.py index b48eed36..293fb2fb 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_entity.py +++ b/nipyapi/nifi/models/variable_registry_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_step_dto.py b/nipyapi/nifi/models/variable_registry_update_step_dto.py index 591b61c8..aa655549 100644 --- a/nipyapi/nifi/models/variable_registry_update_step_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_component_mapping_entity.py b/nipyapi/nifi/models/version_control_component_mapping_entity.py index 21bf8e78..1aa88c17 100644 --- a/nipyapi/nifi/models/version_control_component_mapping_entity.py +++ b/nipyapi/nifi/models/version_control_component_mapping_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_dto.py b/nipyapi/nifi/models/version_control_information_dto.py index 17cadd46..f75d5abf 100644 --- a/nipyapi/nifi/models/version_control_information_dto.py +++ b/nipyapi/nifi/models/version_control_information_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_entity.py b/nipyapi/nifi/models/version_control_information_entity.py index e7e81d3f..b40b9361 100644 --- a/nipyapi/nifi/models/version_control_information_entity.py +++ b/nipyapi/nifi/models/version_control_information_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_info_dto.py b/nipyapi/nifi/models/version_info_dto.py index bd121b13..a75bb349 100644 --- a/nipyapi/nifi/models/version_info_dto.py +++ b/nipyapi/nifi/models/version_info_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_connection.py b/nipyapi/nifi/models/versioned_connection.py index e44126c4..e2acce56 100644 --- a/nipyapi/nifi/models/versioned_connection.py +++ b/nipyapi/nifi/models/versioned_connection.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_controller_service.py b/nipyapi/nifi/models/versioned_controller_service.py index 2a84bd26..87b770fa 100644 --- a/nipyapi/nifi/models/versioned_controller_service.py +++ b/nipyapi/nifi/models/versioned_controller_service.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow.py b/nipyapi/nifi/models/versioned_flow.py index 10531bd5..a65737ce 100644 --- a/nipyapi/nifi/models/versioned_flow.py +++ b/nipyapi/nifi/models/versioned_flow.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_coordinates.py b/nipyapi/nifi/models/versioned_flow_coordinates.py index a975d740..4ad9ce9f 100644 --- a/nipyapi/nifi/models/versioned_flow_coordinates.py +++ b/nipyapi/nifi/models/versioned_flow_coordinates.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_dto.py b/nipyapi/nifi/models/versioned_flow_dto.py index aa5aff88..188e3259 100644 --- a/nipyapi/nifi/models/versioned_flow_dto.py +++ b/nipyapi/nifi/models/versioned_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_entity.py b/nipyapi/nifi/models/versioned_flow_entity.py index 1a8e4c1d..77850b51 100644 --- a/nipyapi/nifi/models/versioned_flow_entity.py +++ b/nipyapi/nifi/models/versioned_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot.py b/nipyapi/nifi/models/versioned_flow_snapshot.py index 851d97ae..3ab9b1ca 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py index df19d8b4..5bdbd63d 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py index 1558c7ab..81480f31 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py index fba55a20..913278e5 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py index 656e68cd..ca7febc7 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_dto.py b/nipyapi/nifi/models/versioned_flow_update_request_dto.py index 6dd65c37..2c395517 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_dto.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_entity.py b/nipyapi/nifi/models/versioned_flow_update_request_entity.py index 56b56c63..c2ca0c40 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_entity.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flows_entity.py b/nipyapi/nifi/models/versioned_flows_entity.py index c5dbeb6b..3d405860 100644 --- a/nipyapi/nifi/models/versioned_flows_entity.py +++ b/nipyapi/nifi/models/versioned_flows_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_funnel.py b/nipyapi/nifi/models/versioned_funnel.py index 1d6c467c..704febf6 100644 --- a/nipyapi/nifi/models/versioned_funnel.py +++ b/nipyapi/nifi/models/versioned_funnel.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_label.py b/nipyapi/nifi/models/versioned_label.py index 03a12374..e8c62ca3 100644 --- a/nipyapi/nifi/models/versioned_label.py +++ b/nipyapi/nifi/models/versioned_label.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter.py b/nipyapi/nifi/models/versioned_parameter.py index 527d4cf8..c7a3c55b 100644 --- a/nipyapi/nifi/models/versioned_parameter.py +++ b/nipyapi/nifi/models/versioned_parameter.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter_context.py b/nipyapi/nifi/models/versioned_parameter_context.py index e6154bbf..066d53f6 100644 --- a/nipyapi/nifi/models/versioned_parameter_context.py +++ b/nipyapi/nifi/models/versioned_parameter_context.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_port.py b/nipyapi/nifi/models/versioned_port.py index b4b5718d..44f71a28 100644 --- a/nipyapi/nifi/models/versioned_port.py +++ b/nipyapi/nifi/models/versioned_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_process_group.py b/nipyapi/nifi/models/versioned_process_group.py index 933c9439..6eac1de0 100644 --- a/nipyapi/nifi/models/versioned_process_group.py +++ b/nipyapi/nifi/models/versioned_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_processor.py b/nipyapi/nifi/models/versioned_processor.py index cdc04227..8ddd94ca 100644 --- a/nipyapi/nifi/models/versioned_processor.py +++ b/nipyapi/nifi/models/versioned_processor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_property_descriptor.py b/nipyapi/nifi/models/versioned_property_descriptor.py index 152334d8..6c5852c4 100644 --- a/nipyapi/nifi/models/versioned_property_descriptor.py +++ b/nipyapi/nifi/models/versioned_property_descriptor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_group_port.py b/nipyapi/nifi/models/versioned_remote_group_port.py index d4aea84b..c1d13618 100644 --- a/nipyapi/nifi/models/versioned_remote_group_port.py +++ b/nipyapi/nifi/models/versioned_remote_group_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_process_group.py b/nipyapi/nifi/models/versioned_remote_process_group.py index d52562c7..2e9022c5 100644 --- a/nipyapi/nifi/models/versioned_remote_process_group.py +++ b/nipyapi/nifi/models/versioned_remote_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index 12300be8..67c26e6a 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.10.0 + OpenAPI spec version: 1.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/resources/client_gen/api_defs/nifi-1.11.1.json b/resources/client_gen/api_defs/nifi-1.11.1.json new file mode 100644 index 00000000..54b56182 --- /dev/null +++ b/resources/client_gen/api_defs/nifi-1.11.1.json @@ -0,0 +1,20689 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", + "version" : "1.11.1-SNAPSHOT", + "title" : "NiFi Rest Api", + "contact" : { + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-api", + "tags" : [ { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "connections", + "description" : "Endpoint for managing a Connection." + }, { + "name" : "controller", + "description" : "Provides realtime command and control of this NiFi instance" + }, { + "name" : "controller-services", + "description" : "Endpoint for managing a Controller Service." + }, { + "name" : "counters", + "description" : "Endpoint for managing counters." + }, { + "name" : "data-transfer", + "description" : "Supports data transfers with this NiFi using HTTP based site to site" + }, { + "name" : "flow", + "description" : "Endpoint for accessing the flow structure and component status." + }, { + "name" : "flowfile-queues", + "description" : "Endpoint for managing a FlowFile Queue." + }, { + "name" : "funnel", + "description" : "Endpoint for managing a Funnel." + }, { + "name" : "input-ports", + "description" : "Endpoint for managing an Input Port." + }, { + "name" : "labels", + "description" : "Endpoint for managing a Label." + }, { + "name" : "output-ports", + "description" : "Endpoint for managing an Output Port." + }, { + "name" : "parameter-contexts", + "description" : "Endpoint for managing version control for a flow" + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "process-groups", + "description" : "Endpoint for managing a Process Group." + }, { + "name" : "processors", + "description" : "Endpoint for managing a Processor." + }, { + "name" : "provenance", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "provenance-events", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "remote-process-groups", + "description" : "Endpoint for managing a Remote Process Group." + }, { + "name" : "reporting-tasks", + "description" : "Endpoint for managing a Reporting Task." + }, { + "name" : "resources", + "description" : "Provides the resources in this NiFi that can have access/authorization policies." + }, { + "name" : "site-to-site", + "description" : "Provide access to site to site with this NiFi" + }, { + "name" : "snippets", + "description" : "Endpoint for accessing dataflow snippets." + }, { + "name" : "system-diagnostics", + "description" : "Endpoint for accessing system diagnostics." + }, { + "name" : "templates", + "description" : "Endpoint for managing a Template." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + }, { + "name" : "versions", + "description" : "Endpoint for managing version control for a flow" + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Gets the status the client's access", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Unable to determine access status because the client could not be authenticated." + }, + "403" : { + "description" : "Unable to determine access status because the client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to determine access status because NiFi is not in the appropriate state." + }, + "500" : { + "description" : "Unable to determine access status because an unexpected error occurred." + } + } + } + }, + "/access/config" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Retrieves the access configuration for this NiFi", + "description" : "", + "operationId" : "getLoginConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessConfigurationEntity" + } + } + } + } + }, + "/access/download-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for downloading FlowFile content.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createDownloadToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/access/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", + "description" : "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 '.", + "operationId" : "createAccessTokenFromTicket", + "consumes" : [ "text/plain" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/knox/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/logout" : { + "delete" : { + "tags" : [ "access" ], + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOut", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/oidc/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/exchange" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcExchange", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + } + } + } + }, + "/access/oidc/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the OpenId Provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via username/password", + "description" : "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 '.", + "operationId" : "createAccessToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "username", + "in" : "formData", + "required" : false, + "type" : "string" + }, { + "name" : "password", + "in" : "formData", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/ui-extension-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for accessing a NiFi UI extension.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createUiExtensionToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/connections/{id}" : { + "get" : { + "tags" : [ "connections" ], + "summary" : "Gets a connection", + "description" : "", + "operationId" : "getConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source - /{component-type}/{uuid}" : [ ] + }, { + "Read Destination - /{component-type}/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "connections" ], + "summary" : "Updates a connection", + "description" : "", + "operationId" : "updateConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + }, { + "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] + }, { + "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] + } ] + }, + "delete" : { + "tags" : [ "connections" ], + "summary" : "Deletes a connection", + "description" : "", + "operationId" : "deleteConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller service", + "description" : "", + "operationId" : "updateControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller-services" ], + "summary" : "Deletes a controller service", + "description" : "", + "operationId" : "removeControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - Controller if scoped by Controller - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/descriptors" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name to return the descriptor for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/references" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerServiceReferences", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller services references", + "description" : "", + "operationId" : "updateControllerServiceReferences", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service request update request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] + } ] + } + }, + "/controller-services/{id}/run-status" : { + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates run status of a controller service", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets the state for a controller service", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "controller-services" ], + "summary" : "Clears the state for a controller service", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller/bulletin" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new bulletin", + "description" : "", + "operationId" : "createBulletin", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/cluster" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the contents of the cluster", + "description" : "Returns the contents of the cluster including all nodes and their status.", + "operationId" : "getCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + } + }, + "/controller/cluster/nodes/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a node in the cluster", + "description" : "", + "operationId" : "getNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a node in the cluster", + "description" : "", + "operationId" : "updateNode", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Removes a node from the cluster", + "description" : "", + "operationId" : "deleteNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/config" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi Controller", + "description" : "", + "operationId" : "getControllerConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi", + "description" : "", + "operationId" : "updateControllerConfig", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/controller-services" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/controller/history" : { + "delete" : { + "tags" : [ "controller" ], + "summary" : "Purges history", + "description" : "", + "operationId" : "deleteHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "endDate", + "in" : "query", + "description" : "Purge actions before this date/time.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the listing of available registry clients", + "description" : "", + "operationId" : "getRegistryClients", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new registry client", + "description" : "", + "operationId" : "createRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a registry client", + "description" : "", + "operationId" : "getRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a registry client", + "description" : "", + "operationId" : "updateRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Deletes a registry client", + "description" : "", + "operationId" : "deleteRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/reporting-tasks" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new reporting task", + "description" : "", + "operationId" : "createReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Reporting Task is restricted - /restricted-components" : [ ] + } ] + } + }, + "/counters" : { + "get" : { + "tags" : [ "counters" ], + "summary" : "Gets the current counters for this NiFi", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getCounters", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CountersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /counters" : [ ] + } ] + } + }, + "/counters/{id}" : { + "put" : { + "tags" : [ "counters" ], + "summary" : "Updates the specified counter. This will reset the counter value to 0", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateCounter", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The id of the counter.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CounterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /counters" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendInputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitInputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files to the input port", + "description" : "", + "operationId" : "receiveFlowFiles", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendOutputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitOutputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "checksum", + "in" : "query", + "description" : "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" : true, + "type" : "string" + }, { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { + "get" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files from the output port", + "description" : "", + "operationId" : "transferFlowFiles", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "There is no flow file to return.", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/{portType}/{portId}/transactions" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Create a transaction to the specified output port or input port", + "description" : "", + "operationId" : "createPortTransaction", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portType", + "in" : "path", + "description" : "The port type.", + "required" : true, + "type" : "string", + "enum" : [ "input-ports", "output-ports" ] + }, { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/about" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves details about this NiFi to put in the About dialog", + "description" : "", + "operationId" : "getAboutInfo", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AboutEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/banners" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the banners for this NiFi", + "description" : "", + "operationId" : "getBanners", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BannerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/bulletin-board" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets current bulletins", + "description" : "", + "operationId" : "getBulletinBoard", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "Includes bulletins with an id after this value.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceName", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose name match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "message", + "in" : "query", + "description" : "Includes bulletins whose message that match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "limit", + "in" : "query", + "description" : "The number of bulletins to limit the response to.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinBoardEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] + } ] + } + }, + "/flow/client-id" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Generates a client id.", + "description" : "", + "operationId" : "generateClientId", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Searches the cluster for a node with the specified address", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Node address to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterSearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/summary" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "The cluster summary for this NiFi", + "description" : "", + "operationId" : "getClusterSummary", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusteSummaryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/config" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the configuration for this NiFi flow", + "description" : "", + "operationId" : "getFlowConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/statistics" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets statistics for a connection", + "description" : "", + "operationId" : "getConnectionStatistics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the statistics.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatisticsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a connection", + "description" : "", + "operationId" : "getConnectionStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history for a connection", + "description" : "", + "operationId" : "getConnectionStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller-service-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of controller services that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getControllerServiceTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "serviceType", + "in" : "query", + "description" : "If specified, will only return controller services that are compatible with this type of service.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleGroup", + "in" : "query", + "description" : "If serviceType specified, is the bundle group of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleArtifact", + "in" : "query", + "description" : "If serviceType specified, is the bundle artifact of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleVersion", + "in" : "query", + "description" : "If serviceType specified, is the bundle version of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "typeFilter", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller/bulletins" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves Controller level bulletins", + "description" : "", + "operationId" : "getBulletins", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerBulletinsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /controller - For controller bulletins" : [ ] + }, { + "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] + }, { + "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] + } ] + } + }, + "/flow/controller/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets controller services for reporting tasks", + "description" : "", + "operationId" : "getControllerServicesFromController", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/current-user" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the user identity of the user making the request", + "description" : "", + "operationId" : "getCurrentUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUserEntity" + } + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "queryHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "The offset into the result set.", + "required" : true, + "type" : "string" + }, { + "name" : "count", + "in" : "query", + "description" : "The number of actions to return.", + "required" : true, + "type" : "string" + }, { + "name" : "sortColumn", + "in" : "query", + "description" : "The field to sort on.", + "required" : false, + "type" : "string" + }, { + "name" : "sortOrder", + "in" : "query", + "description" : "The direction to sort.", + "required" : false, + "type" : "string" + }, { + "name" : "startDate", + "in" : "query", + "description" : "Include actions after this date.", + "required" : false, + "type" : "string" + }, { + "name" : "endDate", + "in" : "query", + "description" : "Include actions before this date.", + "required" : false, + "type" : "string" + }, { + "name" : "userIdentity", + "in" : "query", + "description" : "Include actions performed by this user.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Include actions on this component.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history/components/{componentId}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history for a component", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getComponentHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "componentId", + "in" : "path", + "description" : "The component id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read underlying component - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/history/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets an action", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAction", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The action id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/input-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an input port", + "description" : "", + "operationId" : "getInputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/output-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an output port", + "description" : "", + "operationId" : "getOutputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/parameter-contexts" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all Parameter Contexts", + "description" : "", + "operationId" : "getParameterContexts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] + } ] + } + }, + "/flow/prioritizers" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of prioritizers that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getPrioritizers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PrioritizerTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupFlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Schedule or unschedule components in the specified Process Group.", + "description" : "", + "operationId" : "scheduleComponents", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all controller services", + "description" : "", + "operationId" : "getControllerServicesFromGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include parent/ancestory process groups", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Enable or disable Controller Services in the specified Process Group.", + "description" : "", + "operationId" : "activateControllerServices", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status for a process group", + "description" : "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.", + "operationId" : "getProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "recursive", + "in" : "query", + "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a remote process group", + "description" : "", + "operationId" : "getProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processor-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of processors that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a processor", + "description" : "", + "operationId" : "getProcessorStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a processor", + "description" : "", + "operationId" : "getProcessorStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the listing of available registries", + "description" : "", + "operationId" : "getRegistries", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{id}/buckets" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the buckets from the specified registry for the current user", + "description" : "", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BucketsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flows from the specified registry and bucket for the current user", + "description" : "", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", + "description" : "", + "operationId" : "getVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + }, { + "name" : "flow-id", + "in" : "path", + "description" : "The flow id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history", + "description" : "", + "operationId" : "getRemoteProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-task-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of reporting tasks that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReportingTaskTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-tasks" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all reporting tasks", + "description" : "", + "operationId" : "getReportingTasks", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTasksEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Performs a search against this NiFi using the specified search term", + "description" : "Only search results from authorized components will be returned.", + "operationId" : "searchFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the current status of this NiFi", + "description" : "", + "operationId" : "getControllerStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/templates" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all templates", + "description" : "", + "operationId" : "getTemplates", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplatesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Creates a request to drop the contents of the queue in this connection.", + "description" : "", + "operationId" : "createDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a drop request for the specified connection.", + "description" : "", + "operationId" : "getDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to drop the contents of this connection.", + "description" : "", + "operationId" : "removeDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets a FlowFile from a Connection.", + "description" : "", + "operationId" : "getFlowFile", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowFileEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the content for a FlowFile in a Connection.", + "description" : "", + "operationId" : "downloadFlowFileContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Lists the contents of the queue in this connection.", + "description" : "", + "operationId" : "createFlowFileListing", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a listing request for the specified connection.", + "description" : "", + "operationId" : "getListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to list the contents of this connection.", + "description" : "", + "operationId" : "deleteListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/funnels/{id}" : { + "get" : { + "tags" : [ "funnel" ], + "summary" : "Gets a funnel", + "description" : "", + "operationId" : "getFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /funnels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "funnel" ], + "summary" : "Updates a funnel", + "description" : "", + "operationId" : "updateFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "funnel" ], + "summary" : "Deletes a funnel", + "description" : "", + "operationId" : "removeFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}" : { + "get" : { + "tags" : [ "input-ports" ], + "summary" : "Gets an input port", + "description" : "", + "operationId" : "getInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /input-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates an input port", + "description" : "", + "operationId" : "updateInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "input-ports" ], + "summary" : "Deletes an input port", + "description" : "", + "operationId" : "removeInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}/run-status" : { + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates run status of an input-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] + } ] + } + }, + "/labels/{id}" : { + "get" : { + "tags" : [ "labels" ], + "summary" : "Gets a label", + "description" : "", + "operationId" : "getLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /labels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "labels" ], + "summary" : "Updates a label", + "description" : "", + "operationId" : "updateLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "labels" ], + "summary" : "Deletes a label", + "description" : "", + "operationId" : "removeLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}" : { + "get" : { + "tags" : [ "output-ports" ], + "summary" : "Gets an output port", + "description" : "", + "operationId" : "getOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /output-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates an output port", + "description" : "", + "operationId" : "updateOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "output-ports" ], + "summary" : "Deletes an output port", + "description" : "", + "operationId" : "removeOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}/run-status" : { + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates run status of an output-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] + } ] + } + }, + "/parameter-contexts" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Create a Parameter Context", + "description" : "", + "operationId" : "createParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The Parameter Context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-contexts" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate the Update Request of a Parameter Context", + "description" : "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 acttion 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}.", + "operationId" : "submitParameterContextUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated version of the parameter context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Write - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests/{requestId}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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. ", + "operationId" : "getParameterContextUpdate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the ParameterContext", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", + "description" : "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}.", + "operationId" : "submitValidationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The validation request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Validation Request with the given ID", + "description" : "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. ", + "operationId" : "getValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Validation Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Validation Request with the given ID", + "description" : "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.", + "operationId" : "deleteValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Parameter Context with the given ID", + "description" : "Returns the Parameter Context with the given ID.", + "operationId" : "getParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ] + }, + "put" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Modifies a Parameter Context", + "description" : "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.", + "operationId" : "updateParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated Parameter Context", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + }, { + "Write - /parameter-contexts/{id}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Parameter Context with the given ID", + "description" : "Deletes the Parameter Context with the given ID.", + "operationId" : "deleteParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The Parameter Context ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{uuid}" : [ ] + }, { + "Write - /parameter-contexts/{uuid}" : [ ] + }, { + "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + }, { + "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + } ] + } + }, + "/policies" : { + "post" : { + "tags" : [ "policies" ], + "summary" : "Creates an access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy for the specified action and resource", + "description" : "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.", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Updates a access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Deletes an access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + }, { + "Write - Policy of the parent resource - /policies/{resource}" : [ ] + } ] + } + }, + "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates a process group", + "description" : "", + "operationId" : "updateProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes a process group", + "description" : "", + "operationId" : "removeProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/connections" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all connections", + "description" : "", + "operationId" : "getConnections", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a connection", + "description" : "", + "operationId" : "createConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/controller-services" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/download" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group for download", + "description" : "", + "operationId" : "exportProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/funnels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all funnels", + "description" : "", + "operationId" : "getFunnels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a funnel", + "description" : "", + "operationId" : "createFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/input-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all input ports", + "description" : "", + "operationId" : "getInputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/InputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an input port", + "description" : "", + "operationId" : "createInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/labels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all labels", + "description" : "", + "operationId" : "getLabels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a label", + "description" : "", + "operationId" : "createLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/local-modifications" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", + "description" : "", + "operationId" : "getLocalModifications", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowComparisonEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/output-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all output ports", + "description" : "", + "operationId" : "getOutputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/OutputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an output port", + "description" : "", + "operationId" : "createOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all process groups", + "description" : "", + "operationId" : "getProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a process group", + "description" : "", + "operationId" : "createProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/processors" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all processors", + "description" : "", + "operationId" : "getProcessors", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include processors from descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new processor", + "description" : "", + "operationId" : "createProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Processor is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/remote-process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all remote process groups", + "description" : "", + "operationId" : "getRemoteProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new process group", + "description" : "", + "operationId" : "createRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/snippet-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Copies a snippet and discards it.", + "description" : "", + "operationId" : "copySnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The copy snippet request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CopySnippetRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + }, { + "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/template-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Instantiates a template", + "description" : "", + "operationId" : "instantiateTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The instantiate template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/InstantiateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /templates/{uuid}" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a template and discards the specified snippet.", + "description" : "", + "operationId" : "createTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The create template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/import" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Imports a template", + "description" : "", + "operationId" : "importTemplate", + "consumes" : [ "application/xml" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/upload" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Uploads a template", + "description" : "", + "operationId" : "uploadTemplate", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "template", + "in" : "formData", + "description" : "The binary content of the template file being uploaded.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistry", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include ancestor groups", + "required" : false, + "type" : "boolean", + "default" : true + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates the contents of a Process Group's variable Registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVariableRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry/update-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Submits a request to update a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "submitUpdateVariableRegistryRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets a processor", + "description" : "", + "operationId" : "getProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates a processor", + "description" : "", + "operationId" : "updateProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "processors" ], + "summary" : "Deletes a processor", + "description" : "", + "operationId" : "deleteProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/descriptors" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the descriptor for a processor property", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/diagnostics" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets diagnostics information about a processor", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/run-status" : { + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates run status of a processor", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the state for a processor", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Clears the state for a processor", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/threads" : { + "delete" : { + "tags" : [ "processors" ], + "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", + "description" : "", + "operationId" : "terminateProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/provenance" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a provenance query", + "description" : "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.", + "operationId" : "submitProvenanceRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The provenance query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/replays" : { + "post" : { + "tags" : [ "provenance-events" ], + "summary" : "Replays content from a provenance event", + "description" : "", + "operationId" : "submitReplay", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The replay request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SubmitReplayRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets a provenance event", + "description" : "", + "operationId" : "getProvenanceEvent", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this event exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/input" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the input content for a provenance event", + "description" : "", + "operationId" : "getInputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/output" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the output content for a provenance event", + "description" : "", + "operationId" : "getOutputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a lineage query", + "description" : "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.", + "operationId" : "submitLineageRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The lineage query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a lineage query", + "description" : "", + "operationId" : "getLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a lineage query", + "description" : "", + "operationId" : "deleteLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/search-options" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets the searchable attributes for provenance events", + "description" : "", + "operationId" : "getSearchOptions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceOptionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a provenance query", + "description" : "", + "operationId" : "getProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "summarize", + "in" : "query", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "incrementalResults", + "in" : "query", + "description" : "Whether or not to summarize provenance events returned. This property is false by default.", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a provenance query", + "description" : "", + "operationId" : "deleteProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/remote-process-groups/{id}" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Deletes a remote process group", + "description" : "", + "operationId" : "removeRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroupRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/state" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets the state for a RemoteProcessGroup", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task", + "description" : "", + "operationId" : "getReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates a reporting task", + "description" : "", + "operationId" : "updateReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Deletes a reporting task", + "description" : "", + "operationId" : "removeReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/descriptors" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/run-status" : { + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates run status of a reporting task", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets the state for a reporting task", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Clears the state for a reporting task", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/resources" : { + "get" : { + "tags" : [ "resources" ], + "summary" : "Gets the available resources that support access/authorization policies", + "description" : "", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ResourcesEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /resources" : [ ] + } ] + } + }, + "/site-to-site" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the details about this NiFi necessary to communicate via site to site", + "description" : "", + "operationId" : "getSiteToSiteDetails", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/site-to-site/peers" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the available Peers and its status of this NiFi", + "description" : "", + "operationId" : "getPeers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json", "application/xml" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PeersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/snippets" : { + "post" : { + "tags" : [ "snippets" ], + "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", + "description" : "", + "operationId" : "createSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] + } ] + } + }, + "/snippets/{id}" : { + "put" : { + "tags" : [ "snippets" ], + "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", + "description" : "", + "operationId" : "updateSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + } ] + }, + "delete" : { + "tags" : [ "snippets" ], + "summary" : "Deletes the components in a snippet and discards the snippet", + "description" : "", + "operationId" : "deleteSnippet", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/system-diagnostics" : { + "get" : { + "tags" : [ "system-diagnostics" ], + "summary" : "Gets the diagnostics for the system NiFi is running on", + "description" : "", + "operationId" : "getSystemDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SystemDiagnosticsEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ] + } + }, + "/templates/{id}" : { + "delete" : { + "tags" : [ "templates" ], + "summary" : "Deletes a template", + "description" : "", + "operationId" : "removeTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /templates/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/templates/{id}/download" : { + "get" : { + "tags" : [ "templates" ], + "summary" : "Exports a template", + "description" : "", + "operationId" : "exportTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /templates/{uuid}" : [ ] + } ] + } + }, + "/tenants/search-results" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Searches for a tenant with the specified identity", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchTenants", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Identity to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TenantsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all user groups", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all users", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UsersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/versions/active-requests" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Create a version control request", + "description" : "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.", + "operationId" : "createVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateActiveRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/active-requests/{id}" : { + "put" : { + "tags" : [ "versions" ], + "summary" : "Updates the request with the given ID", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The version control component mapping.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlComponentMappingEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can update it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the version control request with the given ID", + "description" : "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.", + "operationId" : "deleteVersionControlRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/process-groups/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the Version Control information for a process group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVersionInformation", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "versions" ], + "summary" : "Save the Process Group with the given ID", + "description" : "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.", + "operationId" : "saveToFlowRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/StartVersionControlRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "versions" ], + "summary" : "Update the version of a Process Group with the given ID", + "description" : "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.", + "operationId" : "updateFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Stops version controlling the Process Group with the given ID", + "description" : "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.", + "operationId" : "stopVersionControl", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/process-groups/{id}/download" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the latest version of a Process Group for download", + "description" : "", + "operationId" : "exportFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/revert-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Revert Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateRevertFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/revert-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Revert Request with the given ID", + "description" : "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.", + "operationId" : "getRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Revert Request with the given ID", + "description" : "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.", + "operationId" : "deleteRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/update-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Update Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateVersionControlUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/update-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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.", + "operationId" : "getUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + } + }, + "definitions" : { + "AboutDTO" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "The title to be used on the page and in the about dialog." + }, + "version" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "uri" : { + "type" : "string", + "description" : "The URI for the NiFi." + }, + "contentViewerUrl" : { + "type" : "string", + "description" : "The URL for the content viewer if configured." + }, + "timezone" : { + "type" : "string", + "description" : "The timezone of the NiFi instance.", + "readOnly" : true + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "description" : "Build timestamp" + } + } + }, + "AboutEntity" : { + "type" : "object", + "properties" : { + "about" : { + "$ref" : "#/definitions/AboutDTO" + } + }, + "xml" : { + "name" : "aboutEntity" + } + }, + "AccessConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsLogin" : { + "type" : "boolean", + "description" : "Indicates whether or not this NiFi supports user login.", + "readOnly" : true + } + } + }, + "AccessConfigurationEntity" : { + "type" : "object", + "properties" : { + "config" : { + "$ref" : "#/definitions/AccessConfigurationDTO" + } + }, + "xml" : { + "name" : "accessConfigurationEntity" + } + }, + "AccessPolicyDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + } + }, + "AccessPolicyEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicyDTO" + } + }, + "xml" : { + "name" : "accessPolicyEntity" + } + }, + "AccessPolicySummaryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + } + } + }, + "AccessPolicySummaryEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicySummaryDTO" + } + }, + "xml" : { + "name" : "accessPolicySummaryEntity" + } + }, + "AccessStatusDTO" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The user access status.", + "readOnly" : true + }, + "message" : { + "type" : "string", + "description" : "Additional details about the user access status.", + "readOnly" : true + } + }, + "xml" : { + "name" : "accessStatus" + } + }, + "AccessStatusEntity" : { + "type" : "object", + "properties" : { + "accessStatus" : { + "$ref" : "#/definitions/AccessStatusDTO" + } + }, + "xml" : { + "name" : "accessStatusEntity" + } + }, + "ActionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32", + "description" : "The action id." + }, + "userIdentity" : { + "type" : "string", + "description" : "The identity of the user that performed the action." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of the source component." + }, + "componentDetails" : { + "description" : "The details of the source component.", + "$ref" : "#/definitions/ComponentDetailsDTO" + }, + "operation" : { + "type" : "string", + "description" : "The operation that was performed." + }, + "actionDetails" : { + "description" : "The details of the action.", + "$ref" : "#/definitions/ActionDetailsDTO" + } + } + }, + "ActionDetailsDTO" : { + "type" : "object" + }, + "ActionEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "action" : { + "$ref" : "#/definitions/ActionDTO" + } + }, + "xml" : { + "name" : "actionEntity" + } + }, + "ActivateControllerServicesEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "activateControllerServicesEntity" + } + }, + "AffectedComponentDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + } + } + }, + "AffectedComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AffectedComponentDTO" + }, + "processGroup" : { + "description" : "The Process Group that the component belongs to", + "$ref" : "#/definitions/ProcessGroupNameDTO" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of component referenced", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + } + }, + "xml" : { + "name" : "affectedComponentEntity" + } + }, + "AllowableValueDTO" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "A human readable value that is allowed for the property descriptor." + }, + "value" : { + "type" : "string", + "description" : "A value that is allowed for the property descriptor." + }, + "description" : { + "type" : "string", + "description" : "A description for this allowable value." + } + } + }, + "AllowableValueEntity" : { + "type" : "object", + "properties" : { + "allowableValue" : { + "$ref" : "#/definitions/AllowableValueDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "AttributeDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The attribute name." + }, + "value" : { + "type" : "string", + "description" : "The attribute value." + }, + "previousValue" : { + "type" : "string", + "description" : "The value of the attribute before the event took place." + } + } + }, + "BannerDTO" : { + "type" : "object", + "properties" : { + "headerText" : { + "type" : "string", + "description" : "The header text." + }, + "footerText" : { + "type" : "string", + "description" : "The footer text." + } + } + }, + "BannerEntity" : { + "type" : "object", + "properties" : { + "banners" : { + "$ref" : "#/definitions/BannerDTO" + } + }, + "xml" : { + "name" : "bannersEntity" + } + }, + "BatchSettingsDTO" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "Bucket" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket." + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "readOnly" : true, + "minimum" : 1 + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "allowBundleRedeploy" : { + "type" : "boolean", + "description" : "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." + }, + "allowPublicRead" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" + }, + "permissions" : { + "description" : "The access that the current user has to this bucket.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "BucketDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The bucket identifier" + }, + "name" : { + "type" : "string", + "description" : "The bucket name" + }, + "description" : { + "type" : "string", + "description" : "The bucket description" + }, + "created" : { + "type" : "integer", + "format" : "int64", + "description" : "The created timestamp of this bucket" + } + } + }, + "BucketEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "bucket" : { + "$ref" : "#/definitions/BucketDTO" + }, + "permissions" : { + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "bucketEntity" + } + }, + "BucketsEntity" : { + "type" : "object", + "properties" : { + "buckets" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BucketEntity" + } + } + }, + "xml" : { + "name" : "bucketsEntity" + } + }, + "BulletinBoardDTO" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins in the bulletin board, that matches the supplied request.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp when this report was generated." + } + } + }, + "BulletinBoardEntity" : { + "type" : "object", + "properties" : { + "bulletinBoard" : { + "$ref" : "#/definitions/BulletinBoardDTO" + } + }, + "xml" : { + "name" : "bulletinBoardEntity" + } + }, + "BulletinDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "description" : "The id of the bulletin." + }, + "nodeAddress" : { + "type" : "string", + "description" : "If clustered, the address of the node from which the bulletin originated." + }, + "category" : { + "type" : "string", + "description" : "The category of this bulletin." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the source component." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "level" : { + "type" : "string", + "description" : "The level of the bulletin." + }, + "message" : { + "type" : "string", + "description" : "The bulletin message." + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + } + } + }, + "BulletinEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "groupId" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + }, + "nodeAddress" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "bulletin" : { + "$ref" : "#/definitions/BulletinDTO" + } + }, + "xml" : { + "name" : "bulletinEntity" + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleDTO" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle." + } + } + }, + "ClusteSummaryEntity" : { + "type" : "object", + "properties" : { + "clusterSummary" : { + "$ref" : "#/definitions/ClusterSummaryDTO" + } + }, + "xml" : { + "name" : "clusterSummaryEntity" + } + }, + "ClusterDTO" : { + "type" : "object", + "properties" : { + "nodes" : { + "type" : "array", + "description" : "The collection of nodes that are part of the cluster.", + "items" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp the report was generated." + } + } + }, + "ClusterEntity" : { + "type" : "object", + "properties" : { + "cluster" : { + "$ref" : "#/definitions/ClusterDTO" + } + }, + "xml" : { + "name" : "clusterEntity" + } + }, + "ClusterSearchResultsEntity" : { + "type" : "object", + "properties" : { + "nodeResults" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NodeSearchResultDTO" + } + } + }, + "xml" : { + "name" : "clusterSearchResultsEntity" + } + }, + "ClusterSummaryDTO" : { + "type" : "object", + "properties" : { + "connectedNodes" : { + "type" : "string", + "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." + }, + "connectedNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes that are currently connected to the cluster" + }, + "totalNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" + }, + "clustered" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is clustered." + }, + "connectedToCluster" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is connected to a cluster." + } + } + }, + "ComponentDetailsDTO" : { + "type" : "object" + }, + "ComponentDifferenceDTO" : { + "type" : "object", + "properties" : { + "componentType" : { + "type" : "string", + "description" : "The type of component" + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the component belongs to" + }, + "differences" : { + "type" : "array", + "description" : "The differences in the component between the two flows", + "items" : { + "$ref" : "#/definitions/DifferenceDTO" + } + } + } + }, + "ComponentHistoryDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component id." + }, + "propertyHistory" : { + "type" : "object", + "description" : "The history for the properties of the component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyHistoryDTO" + } + } + } + }, + "ComponentHistoryEntity" : { + "type" : "object", + "properties" : { + "componentHistory" : { + "$ref" : "#/definitions/ComponentHistoryDTO" + } + }, + "xml" : { + "name" : "componentHistoryEntity" + } + }, + "ComponentReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component." + } + } + }, + "ComponentReferenceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "component" : { + "$ref" : "#/definitions/ComponentReferenceDTO" + } + }, + "xml" : { + "name" : "componentReferenceEntity" + } + }, + "ComponentRestrictionPermissionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "permissions" : { + "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + } + } + }, + "ComponentSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component that matched the search." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the component that matched the search." + }, + "parentGroup" : { + "description" : "The parent group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "versionedGroup" : { + "description" : "The nearest versioned ancestor group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component that matched the search." + }, + "matches" : { + "type" : "array", + "description" : "What matched the search from the component.", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentStateDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component identifier." + }, + "stateDescription" : { + "type" : "string", + "description" : "Description of the state this component persists." + }, + "clusterState" : { + "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", + "$ref" : "#/definitions/StateMapDTO" + }, + "localState" : { + "description" : "The local state for this component.", + "$ref" : "#/definitions/StateMapDTO" + } + } + }, + "ComponentStateEntity" : { + "type" : "object", + "properties" : { + "componentState" : { + "description" : "The component state.", + "$ref" : "#/definitions/ComponentStateDTO" + } + }, + "xml" : { + "name" : "componentStateEntity" + } + }, + "ComponentValidationResultDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "currentlyValid" : { + "type" : "boolean", + "description" : "Whether or not the component is currently valid" + }, + "resultsValid" : { + "type" : "boolean", + "description" : "Whether or not the component will be valid if the Parameter Context is changed" + }, + "resultantValidationErrors" : { + "type" : "array", + "description" : "The validation errors that will apply to the component if the Parameter Context is changed", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentValidationResultEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ComponentValidationResultDTO" + } + }, + "xml" : { + "name" : "componentValidationResultEntity" + } + }, + "ComponentValidationResultsEntity" : { + "type" : "object", + "properties" : { + "validationResults" : { + "type" : "array", + "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", + "items" : { + "$ref" : "#/definitions/ComponentValidationResultEntity" + } + } + }, + "xml" : { + "name" : "componentValidationResults" + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectableDTO" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "running" : { + "type" : "boolean", + "description" : "Reflects the current state of the connectable component." + }, + "transmitting" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." + }, + "exists" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target exists." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "availableRelationships" : { + "type" : "array", + "description" : "The relationships that the source of the connection currently supports.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "How to load balance the data in this Connection across the nodes in the cluster.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "loadBalancePartitionAttribute" : { + "type" : "string", + "description" : "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" + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "loadBalanceStatus" : { + "type" : "string", + "description" : "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.", + "readOnly" : true, + "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] + } + } + }, + "ConnectionEntity" : { + "type" : "object", + "required" : [ "destinationType", "sourceType" ], + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ConnectionDTO" + }, + "status" : { + "description" : "The status of the connection.", + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The identifier of the source of this connection." + }, + "sourceGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the source of this connection." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of component the source connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "destinationId" : { + "type" : "string", + "description" : "The identifier of the destination of this connection." + }, + "destinationGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the destination of this connection." + }, + "destinationType" : { + "type" : "string", + "description" : "The type of component the destination connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + } + }, + "xml" : { + "name" : "connectionEntity" + } + }, + "ConnectionStatisticsDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" + } + } + } + }, + "ConnectionStatisticsEntity" : { + "type" : "object", + "properties" : { + "connectionStatistics" : { + "$ref" : "#/definitions/ConnectionStatisticsDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatisticsEntity" + } + }, + "ConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of queued objects at the next configured interval." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." + }, + "predictionIntervalMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The prediction interval in seconds" + } + } + }, + "ConnectionStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the connection belongs to" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "sourceId" : { + "type" : "string", + "description" : "The ID of the source component" + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component" + }, + "destinationId" : { + "type" : "string", + "description" : "The ID of the destination component" + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination component" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" + } + } + } + }, + "ConnectionStatusEntity" : { + "type" : "object", + "properties" : { + "connectionStatus" : { + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatusEntity" + } + }, + "ConnectionStatusPredictionsSnapshotDTO" : { + "type" : "object", + "properties" : { + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictionIntervalSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the process group the connection belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source of the connection." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source of the connection." + }, + "destinationId" : { + "type" : "string", + "description" : "The id of the destination of the connection." + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination of the connection." + }, + "predictions" : { + "description" : "Predictions, if available, for this connection (null if not available)", + "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have left the connection in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are currently queued in the connection." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that are currently queued in the connection." + }, + "queued" : { + "type" : "string", + "description" : "The total count and size of queued flowfiles formatted." + }, + "queuedSize" : { + "type" : "string", + "description" : "The total size of flowfiles that are queued formatted." + }, + "queuedCount" : { + "type" : "string", + "description" : "The number of flowfiles that are queued, pretty printed." + }, + "percentUseCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "percentUseBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "connectionStatusSnapshot" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ConnectionsEntity" : { + "type" : "object", + "properties" : { + "connections" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } + }, + "xml" : { + "name" : "connectionsEntity" + } + }, + "ControllerBulletinsEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "System level bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "controllerServiceBulletins" : { + "type" : "array", + "description" : "Controller service bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "reportingTaskBulletins" : { + "type" : "array", + "description" : "Reporting task bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerConfigurationDTO" : { + "type" : "object", + "properties" : { + "maxTimerDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of timer driven threads the NiFi has available." + }, + "maxEventDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of event driven threads the NiFi has available." + } + } + }, + "ControllerConfigurationEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/ControllerConfigurationDTO" + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the NiFi." + }, + "name" : { + "type" : "string", + "description" : "The name of the NiFi." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the NiFi." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports contained in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports contained in the NiFi." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports contained in the NiFi." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the NiFi." + }, + "remoteSiteListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "remoteSiteHttpListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "siteToSiteSecure" : { + "type" : "boolean", + "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." + }, + "instanceId" : { + "type" : "string", + "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports available to send data to for the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports available to received data from the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + } + } + }, + "ControllerEntity" : { + "type" : "object", + "properties" : { + "controller" : { + "$ref" : "#/definitions/ControllerDTO" + } + }, + "xml" : { + "name" : "controllerEntity" + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceApiDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "ControllerServiceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the controller service." + }, + "state" : { + "type" : "string", + "description" : "The state of the controller service.", + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the controller service persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the controller service requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the ontroller service has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the controller service has multiple versions available." + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the controller service properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the controller services custom configuration UI if applicable." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "referencingComponents" : { + "type" : "array", + "description" : "All components referencing this controller service.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ControllerServiceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this ControllerService." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ControllerService.", + "readOnly" : true, + "$ref" : "#/definitions/ControllerServiceStatusDTO" + } + }, + "xml" : { + "name" : "controllerServiceEntity" + } + }, + "ControllerServiceReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "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." + }, + "id" : { + "type" : "string", + "description" : "The id of the component referencing a controller service." + }, + "name" : { + "type" : "string", + "description" : "The name of the component referencing a controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the component referencing a controller service in simple Java class name format without package name." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the component properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "referenceType" : { + "type" : "string", + "description" : "The type of reference this is.", + "enum" : [ "Processor", "ControllerService", "ReportingTask" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "referenceCycle" : { + "type" : "boolean", + "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." + }, + "referencingComponents" : { + "type" : "array", + "description" : "If the referencing component represents a controller service, these are the components that reference it.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + } + }, + "ControllerServiceReferencingComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentEntity" + } + }, + "ControllerServiceReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "controllerServiceReferencingComponents" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentsEntity" + } + }, + "ControllerServiceRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ControllerService.", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ControllerServiceStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ControllerService", + "readOnly" : true, + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ControllerServiceTypesEntity" : { + "type" : "object", + "properties" : { + "controllerServiceTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "controllerServiceTypesEntity" + } + }, + "ControllerServicesEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "controllerServices" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } + }, + "xml" : { + "name" : "controllerServicesEntity" + } + }, + "ControllerStatusDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads in the NiFi." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of terminated threads in the NiFi." + }, + "queued" : { + "type" : "string", + "description" : "The number of flowfiles queued in the NiFi." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles queued across the entire flow" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles queued across the entire flow" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the NiFi." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the NiFi." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the NiFi." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the NiFi." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the NiFi." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." + } + } + }, + "ControllerStatusEntity" : { + "type" : "object", + "properties" : { + "controllerStatus" : { + "$ref" : "#/definitions/ControllerStatusDTO" + } + }, + "xml" : { + "name" : "controllerStatusEntity" + } + }, + "CopySnippetRequestEntity" : { + "type" : "object", + "properties" : { + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "CounterDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the counter." + }, + "context" : { + "type" : "string", + "description" : "The context of the counter." + }, + "name" : { + "type" : "string", + "description" : "The name of the counter." + }, + "valueCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The value count." + }, + "value" : { + "type" : "string", + "description" : "The value of the counter." + } + } + }, + "CounterEntity" : { + "type" : "object", + "properties" : { + "counter" : { + "$ref" : "#/definitions/CounterDTO" + } + }, + "xml" : { + "name" : "counterEntity" + } + }, + "CountersDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/CountersSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeCountersSnapshotDTO" + } + } + } + }, + "CountersEntity" : { + "type" : "object", + "properties" : { + "counters" : { + "$ref" : "#/definitions/CountersDTO" + } + }, + "xml" : { + "name" : "countersEntity" + } + }, + "CountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "counters" : { + "type" : "array", + "description" : "All counters in the NiFi.", + "items" : { + "$ref" : "#/definitions/CounterDTO" + } + } + } + }, + "CreateActiveRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The Process Group ID that this active request will update" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createActiveRequestEntity" + } + }, + "CreateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createTemplateRequestEntity" + } + }, + "CurrentUserEntity" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity being serialized." + }, + "anonymous" : { + "type" : "boolean", + "description" : "Whether the current user is anonymous." + }, + "provenancePermissions" : { + "description" : "Permissions for querying provenance.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "countersPermissions" : { + "description" : "Permissions for accessing counters.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "tenantsPermissions" : { + "description" : "Permissions for accessing tenants.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "controllerPermissions" : { + "description" : "Permissions for accessing the controller.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "policiesPermissions" : { + "description" : "Permissions for accessing the policies.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "systemPermissions" : { + "description" : "Permissions for accessing system.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "parameterContextPermissions" : { + "description" : "Permissions for accessing parameter contexts.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "restrictedComponentsPermissions" : { + "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "componentRestrictionPermissions" : { + "type" : "array", + "description" : "Permissions for specific component restrictions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" + } + }, + "canVersionFlows" : { + "type" : "boolean", + "description" : "Whether the current user can version flows." + } + }, + "xml" : { + "name" : "currentEntity" + } + }, + "DifferenceDTO" : { + "type" : "object", + "properties" : { + "differenceType" : { + "type" : "string", + "description" : "The type of difference" + }, + "difference" : { + "type" : "string", + "description" : "Description of the difference" + } + } + }, + "DimensionsDTO" : { + "type" : "object", + "properties" : { + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + } + } + }, + "DocumentedTypeDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the type." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "If this type represents a ControllerService, this lists the APIs it implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the type." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether this type is restricted." + }, + "usageRestriction" : { + "type" : "string", + "description" : "The optional description of why the usage of this component is restricted." + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExplicitRestrictionDTO" + } + }, + "deprecationReason" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted." + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "DropRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this drop request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this drop request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this drop request failed." + }, + "currentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files currently queued." + }, + "currentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files currently queued in bytes." + }, + "current" : { + "type" : "string", + "description" : "The count and size of flow files currently queued." + }, + "originalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files to be dropped as a result of this request." + }, + "originalSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files to be dropped as a result of this request in bytes." + }, + "original" : { + "type" : "string", + "description" : "The count and size of flow files to be dropped as a result of this request." + }, + "droppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files that have been dropped thus far." + }, + "droppedSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files that have been dropped thus far in bytes." + }, + "dropped" : { + "type" : "string", + "description" : "The count and size of flow files that have been dropped thus far." + }, + "state" : { + "type" : "string", + "description" : "The current state of the drop request." + } + } + }, + "DropRequestEntity" : { + "type" : "object", + "properties" : { + "dropRequest" : { + "$ref" : "#/definitions/DropRequestDTO" + } + }, + "xml" : { + "name" : "dropRequestEntity" + } + }, + "ExplicitRestrictionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "explanation" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted for this required permission." + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "FlowBreadcrumbDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The id of the group." + }, + "versionControlInformation" : { + "description" : "The process group version control information or null if not version controlled.", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "FlowBreadcrumbEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this ancestor ProcessGroup." + }, + "permissions" : { + "description" : "The permissions for this ancestor ProcessGroup.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "breadcrumb" : { + "description" : "This breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbDTO" + }, + "parentBreadcrumb" : { + "description" : "The parent breadcrumb for this breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowComparisonEntity" : { + "type" : "object", + "properties" : { + "componentDifferences" : { + "type" : "array", + "description" : "The list of differences for each component in the flow that is not the same between the two flows", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceDTO" + } + } + }, + "xml" : { + "name" : "flowComparisonEntity" + } + }, + "FlowConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi supports configurable users and groups.", + "readOnly" : true + }, + "autoRefreshIntervalSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "The interval in seconds between the automatic NiFi refresh requests.", + "readOnly" : true + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the system." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The default back pressure object threshold." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The default back pressure data size threshold." + } + } + }, + "FlowConfigurationEntity" : { + "type" : "object", + "properties" : { + "flowConfiguration" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/FlowConfigurationDTO" + } + }, + "xml" : { + "name" : "flowConfigurationEntity" + } + }, + "FlowDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + } + }, + "FlowEntity" : { + "type" : "object", + "properties" : { + "flow" : { + "$ref" : "#/definitions/FlowDTO" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowFileDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "attributes" : { + "type" : "object", + "description" : "The FlowFile attributes.", + "additionalProperties" : { + "type" : "string" + } + }, + "contentClaimSection" : { + "type" : "string", + "description" : "The section in which the content claim lives." + }, + "contentClaimContainer" : { + "type" : "string", + "description" : "The container in which the content claim lives." + }, + "contentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the content claim." + }, + "contentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the content claim where the flowfile's content begins." + }, + "contentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the content claim formatted." + }, + "contentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the content claim in bytes." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowFileEntity" : { + "type" : "object", + "properties" : { + "flowFile" : { + "$ref" : "#/definitions/FlowFileDTO" + } + }, + "xml" : { + "name" : "flowFileEntity" + } + }, + "FlowFileSummaryDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowSnippetDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupDTO" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorDTO" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDTO" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The controller services in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceDTO" + } + } + } + }, + "FunnelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + } + } + }, + "FunnelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "xml" : { + "name" : "funnelEntity" + } + }, + "FunnelsEntity" : { + "type" : "object", + "properties" : { + "funnels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + }, + "xml" : { + "name" : "funnelsEntity" + } + }, + "GarbageCollectionDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the garbage collector." + }, + "collectionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of times garbage collection has run." + }, + "collectionTime" : { + "type" : "string", + "description" : "The total amount of time spent garbage collecting." + }, + "collectionMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of milliseconds spent garbage collecting." + } + } + }, + "HistoryDTO" : { + "type" : "object", + "properties" : { + "total" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of number of actions that matched the search criteria.." + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "actions" : { + "type" : "array", + "description" : "The actions.", + "items" : { + "$ref" : "#/definitions/ActionEntity" + } + } + } + }, + "HistoryEntity" : { + "type" : "object", + "properties" : { + "history" : { + "$ref" : "#/definitions/HistoryDTO" + } + }, + "xml" : { + "name" : "historyEntity" + } + }, + "InputPortsEntity" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "inputPortsEntity" + } + }, + "InstantiateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "templateId" : { + "type" : "string", + "description" : "The identifier of the template." + }, + "encodingVersion" : { + "type" : "string", + "description" : "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." + }, + "snippet" : { + "description" : "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.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "instantiateTemplateRequestEntity" + } + }, + "JaxbLink" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "format" : "uri", + "xml" : { + "attribute" : true + }, + "description" : "The href for the link" + }, + "params" : { + "type" : "object", + "description" : "The params for the link", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "dimensions" : { + "$ref" : "#/definitions/DimensionsDTO" + }, + "component" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "xml" : { + "name" : "labelEntity" + } + }, + "LabelsEntity" : { + "type" : "object", + "properties" : { + "labels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + } + }, + "xml" : { + "name" : "labelsEntity" + } + }, + "LineageDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this lineage query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this lineage query for later retrieval and deletion." + }, + "submissionTime" : { + "type" : "string", + "description" : "When the lineage query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "When the lineage query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percent complete for the lineage query." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the lineage query has finished." + }, + "request" : { + "description" : "The initial lineage result.", + "$ref" : "#/definitions/LineageRequestDTO" + }, + "results" : { + "description" : "The results of the lineage query.", + "$ref" : "#/definitions/LineageResultsDTO" + } + } + }, + "LineageEntity" : { + "type" : "object", + "properties" : { + "lineage" : { + "$ref" : "#/definitions/LineageDTO" + } + }, + "xml" : { + "name" : "lineageEntity" + } + }, + "LineageRequestDTO" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lineageRequestType" : { + "type" : "string", + "description" : "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.", + "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] + }, + "uuid" : { + "type" : "string", + "description" : "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." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this lineage originated if clustered." + } + } + }, + "LineageResultsDTO" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while generating the lineage.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "nodes" : { + "type" : "array", + "description" : "The nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceNodeDTO" + } + }, + "links" : { + "type" : "array", + "description" : "The links between the nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceLinkDTO" + } + } + } + }, + "ListingRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this listing request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this listing request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this listing request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this listing request failed." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of FlowFileSummary objects to return" + }, + "state" : { + "type" : "string", + "description" : "The current state of the listing request." + }, + "queueSize" : { + "description" : "The size of the queue", + "$ref" : "#/definitions/QueueSizeDTO" + }, + "flowFileSummaries" : { + "type" : "array", + "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", + "items" : { + "$ref" : "#/definitions/FlowFileSummaryDTO" + } + }, + "sourceRunning" : { + "type" : "boolean", + "description" : "Whether the source of the connection is running" + }, + "destinationRunning" : { + "type" : "boolean", + "description" : "Whether the destination of the connection is running" + } + } + }, + "ListingRequestEntity" : { + "type" : "object", + "properties" : { + "listingRequest" : { + "$ref" : "#/definitions/ListingRequestDTO" + } + }, + "xml" : { + "name" : "listingRequestEntity" + } + }, + "NodeConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statisticsSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + } + } + }, + "NodeConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + } + } + }, + "NodeCountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The counters from the node.", + "$ref" : "#/definitions/CountersSnapshotDTO" + } + } + }, + "NodeDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node.", + "readOnly" : true + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address.", + "readOnly" : true + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The node's status." + }, + "heartbeat" : { + "type" : "string", + "description" : "the time of the nodes's last heartbeat.", + "readOnly" : true + }, + "connectionRequested" : { + "type" : "string", + "description" : "The time of the node's last connection request.", + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "The roles of this node.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active threads for the NiFi on the node.", + "readOnly" : true + }, + "queued" : { + "type" : "string", + "description" : "The queue the NiFi on the node.", + "readOnly" : true + }, + "events" : { + "type" : "array", + "description" : "The node's events.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/NodeEventDTO" + } + }, + "nodeStartTime" : { + "type" : "string", + "description" : "The time at which this Node was last refreshed.", + "readOnly" : true + } + } + }, + "NodeEntity" : { + "type" : "object", + "properties" : { + "node" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "xml" : { + "name" : "nodeEntity" + } + }, + "NodeEventDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node event." + }, + "category" : { + "type" : "string", + "description" : "The category of the node event." + }, + "message" : { + "type" : "string", + "description" : "The message in the node event." + } + } + }, + "NodePortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The port status snapshot from the node.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + } + } + }, + "NodeProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The process group status snapshot from the node.", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The processor status snapshot from the node.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + } + } + }, + "NodeRemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The remote process group status snapshot from the node.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node that matched the search." + }, + "address" : { + "type" : "string", + "description" : "The address of the node that matched the search." + } + } + }, + "NodeStatusSnapshotsDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node." + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address." + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests." + }, + "statusSnapshots" : { + "type" : "array", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + } + } + }, + "NodeSystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The System Diagnostics snapshot from the node.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + } + } + }, + "OutputPortsEntity" : { + "type" : "object", + "properties" : { + "outputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "outputPortsEntity" + } + }, + "ParameterContextDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The Name of the Parameter Context." + }, + "description" : { + "type" : "string", + "description" : "The Description of the Parameter Context." + }, + "parameters" : { + "type" : "array", + "description" : "The Parameters for the Parameter Context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterEntity" + } + }, + "boundProcessGroups" : { + "type" : "array", + "description" : "The Process Groups that are bound to this Parameter Context", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "id" : { + "type" : "string", + "description" : "The ID the Parameter Context.", + "readOnly" : true + } + } + }, + "ParameterContextEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The Parameter Context", + "$ref" : "#/definitions/ParameterContextDTO" + } + }, + "xml" : { + "name" : "parameterContextEntity" + } + }, + "ParameterContextReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Parameter Context" + }, + "name" : { + "type" : "string", + "description" : "The name of the Parameter Context" + } + } + }, + "ParameterContextReferenceEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "component" : { + "$ref" : "#/definitions/ParameterContextReferenceDTO" + } + }, + "xml" : { + "name" : "parameterContextReferenceEntity" + } + }, + "ParameterContextUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextUpdateStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "$ref" : "#/definitions/ParameterContextDTO" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterContextUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "parameterContextRevision" : { + "description" : "The Revision of the Parameter Context", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" + } + }, + "xml" : { + "name" : "parameterContextUpdateRequestEntity" + } + }, + "ParameterContextUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextValidationRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextValidationStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on.", + "$ref" : "#/definitions/ParameterContextDTO" + }, + "componentValidationResults" : { + "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", + "readOnly" : true, + "$ref" : "#/definitions/ComponentValidationResultsEntity" + } + } + }, + "ParameterContextValidationRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextValidationRequestDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "parameterContextValidationRequestEntity" + } + }, + "ParameterContextValidationStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextsEntity" : { + "type" : "object", + "properties" : { + "parameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system.", + "readOnly" : true + } + }, + "xml" : { + "name" : "parameterContexts" + } + }, + "ParameterDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the Parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the Parameter" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the Parameter" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing this Parameter", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterEntity" : { + "type" : "object", + "properties" : { + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "parameter" : { + "description" : "The parameter information", + "$ref" : "#/definitions/ParameterDTO" + } + }, + "xml" : { + "name" : "parameterEntity" + } + }, + "PeerDTO" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "The hostname of this peer." + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "The port number of this peer." + }, + "secure" : { + "type" : "boolean", + "description" : "Returns if this peer connection is secure." + }, + "flowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flowFiles this peer holds." + } + } + }, + "PeersEntity" : { + "type" : "object", + "properties" : { + "peers" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PeerDTO" + } + } + }, + "xml" : { + "name" : "peersEntity" + } + }, + "Permissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + } + } + }, + "PermissionsDTO" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + } + }, + "PortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the port." + }, + "state" : { + "type" : "string", + "description" : "The state of the port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "transmitting" : { + "type" : "boolean", + "description" : "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." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "userAccessControl" : { + "type" : "array", + "description" : "The users that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "groupAccessControl" : { + "type" : "array", + "description" : "The user groups that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + } + } + }, + "PortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/PortDTO" + }, + "status" : { + "description" : "The status of the port.", + "$ref" : "#/definitions/PortStatusDTO" + }, + "portType" : { + "type" : "string" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + } + }, + "xml" : { + "name" : "portEntity" + } + }, + "PortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "PortStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodePortStatusSnapshotDTO" + } + } + } + }, + "PortStatusEntity" : { + "type" : "object", + "properties" : { + "portStatus" : { + "$ref" : "#/definitions/PortStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "portStatusEntity" + } + }, + "PortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for the port." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been processed in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have been processed in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + } + } + }, + "PortStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "portStatusSnapshot" : { + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "PositionDTO" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "PreviousValueDTO" : { + "type" : "object", + "properties" : { + "previousValue" : { + "type" : "string", + "description" : "The previous value." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the value was modified." + }, + "userIdentity" : { + "type" : "string", + "description" : "The user who changed the previous value." + } + } + }, + "PrioritizerTypesEntity" : { + "type" : "object", + "properties" : { + "prioritizerTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "prioritizerTypesEntity" + } + }, + "ProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the process group." + }, + "variables" : { + "type" : "object", + "description" : "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.", + "readOnly" : true, + "additionalProperties" : { + "type" : "string" + } + }, + "versionControlInformation" : { + "description" : "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", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "parameterContext" : { + "description" : "The Parameter Context that this Process Group is bound to.", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "contents" : { + "description" : "The contents of this process group.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + } + }, + "ProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessGroupDTO" + }, + "status" : { + "description" : "The status of the process group.", + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "versionedFlowSnapshot" : { + "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupEntity" + } + }, + "ProcessGroupFlowDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "breadcrumb" : { + "description" : "The breadcrumb of the process group.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + }, + "flow" : { + "description" : "The flow structure starting at this Process Group.", + "$ref" : "#/definitions/FlowDTO" + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The time the flow for the process group was last refreshed." + } + } + }, + "ProcessGroupFlowEntity" : { + "type" : "object", + "properties" : { + "permissions" : { + "description" : "The access policy for this process group.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "processGroupFlow" : { + "$ref" : "#/definitions/ProcessGroupFlowDTO" + } + }, + "xml" : { + "name" : "processGroupFlowEntity" + } + }, + "ProcessGroupNameDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" + } + } + }, + "ProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "The aggregate status of all nodes in the cluster", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" + } + } + } + }, + "ProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "processGroupStatus" : { + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupStatusEntity" + } + }, + "ProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "name" : { + "type" : "string", + "description" : "The name of this process group." + }, + "connectionStatusSnapshots" : { + "type" : "array", + "description" : "The status of all connections in the process group.", + "items" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" + } + }, + "processorStatusSnapshots" : { + "type" : "array", + "description" : "The status of all processors in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" + } + }, + "processGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all process groups in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" + } + }, + "remoteProcessGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all remote process groups in the process group.", + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" + } + }, + "inputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all input ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "outputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all output ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are queued up in this ProcessGroup right now" + }, + "queued" : { + "type" : "string", + "description" : "The count/size that is queued in the the process group." + }, + "queuedCount" : { + "type" : "string", + "description" : "The count that is queued for the process group." + }, + "queuedSize" : { + "type" : "string", + "description" : "The size that is queued for the process group." + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The output count/size for the process group in the last 5 minutes." + }, + "flowFilesTransferred" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" + }, + "bytesTransferred" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" + }, + "transferred" : { + "type" : "string", + "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "received" : { + "type" : "string", + "description" : "The count/size sent to the process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "sent" : { + "type" : "string", + "description" : "The count/size sent from this process group in the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for this process group." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the process group." + } + } + }, + "ProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "processGroupStatusSnapshot" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "processGroupsEntity" + } + }, + "ProcessorConfigDTO" : { + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "Descriptors for the processor's properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the processor." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the processor's custom configuration UI if applicable." + }, + "lossTolerant" : { + "type" : "boolean", + "description" : "Whether the processor is loss tolerant." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "defaultConcurrentTasks" : { + "type" : "object", + "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "ProcessorDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the processor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the processor", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "style" : { + "type" : "object", + "description" : "Styles for the processor (background-color : #eee).", + "additionalProperties" : { + "type" : "string" + } + }, + "relationships" : { + "type" : "array", + "description" : "The available relationships that the processor currently supports.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/RelationshipDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the processor." + }, + "supportsParallelProcessing" : { + "type" : "boolean", + "description" : "Whether the processor supports parallel processing." + }, + "supportsEventDriven" : { + "type" : "boolean", + "description" : "Whether the processor supports event driven scheduling." + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether the processor supports batching. This makes the run duration settings available." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the processor persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the processor requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the processor has been deprecated." + }, + "executionNodeRestricted" : { + "type" : "boolean", + "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the processor has multiple versions available." + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "config" : { + "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", + "$ref" : "#/definitions/ProcessorConfigDTO" + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ProcessorEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessorDTO" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "status" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "processorEntity" + } + }, + "ProcessorRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Processor.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the Processor" + }, + "type" : { + "type" : "string", + "description" : "The type of the Processor" + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the Processor", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" + } + } + } + }, + "ProcessorStatusEntity" : { + "type" : "object", + "properties" : { + "processorStatus" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processorStatusEntity" + } + }, + "ProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group to which the processor belongs." + }, + "name" : { + "type" : "string", + "description" : "The name of the prcessor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "runStatus" : { + "type" : "string", + "description" : "The state of the processor.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute.", + "enum" : [ "ALL", "PRIMARY" ] + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by this Processor in the last 5 mintues" + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by this Processor in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "taskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of times this Processor has run in the last 5 minutes" + }, + "tasksDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" + }, + "tasks" : { + "type" : "string", + "description" : "The total number of task this connectable has completed over the last 5 minutes." + }, + "tasksDuration" : { + "type" : "string", + "description" : "The total duration of all tasks for this connectable over the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently executing in the processor." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the processor." + } + } + }, + "ProcessorStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "processorStatusSnapshot" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorTypesEntity" : { + "type" : "object", + "properties" : { + "processorTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "processorTypesEntity" + } + }, + "ProcessorsEntity" : { + "type" : "object", + "properties" : { + "processors" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } + }, + "xml" : { + "name" : "processorsEntity" + } + }, + "PropertyDescriptorDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name for the property." + }, + "displayName" : { + "type" : "string", + "description" : "The human readable name for the property." + }, + "description" : { + "type" : "string", + "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value for the property." + }, + "allowableValues" : { + "type" : "array", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "items" : { + "$ref" : "#/definitions/AllowableValueEntity" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether the property is required." + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether the property is sensitive and protected whenever stored or represented." + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether the property is dynamic (user-defined)." + }, + "supportsEl" : { + "type" : "boolean", + "description" : "Whether the property supports expression language." + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "Scope of the Expression Language evaluation for the property." + }, + "identifiesControllerService" : { + "type" : "string", + "description" : "If the property identifies a controller service this returns the fully qualified type." + }, + "identifiesControllerServiceBundle" : { + "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "PropertyDescriptorEntity" : { + "type" : "object", + "properties" : { + "propertyDescriptor" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "xml" : { + "name" : "propertyDescriptor" + } + }, + "PropertyHistoryDTO" : { + "type" : "object", + "properties" : { + "previousValues" : { + "type" : "array", + "description" : "Previous values for a given property.", + "items" : { + "$ref" : "#/definitions/PreviousValueDTO" + } + } + } + }, + "ProvenanceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the provenance query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "The timestamp when the query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "request" : { + "description" : "The provenance request.", + "$ref" : "#/definitions/ProvenanceRequestDTO" + }, + "results" : { + "description" : "The provenance results.", + "$ref" : "#/definitions/ProvenanceResultsDTO" + } + } + }, + "ProvenanceEntity" : { + "type" : "object", + "properties" : { + "provenance" : { + "$ref" : "#/definitions/ProvenanceDTO" + } + }, + "xml" : { + "name" : "provenanceEntity" + } + }, + "ProvenanceEventDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The event uuid." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id. This is a one up number thats unique per node." + }, + "eventTime" : { + "type" : "string", + "description" : "The timestamp of the event." + }, + "eventDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The event duration in milliseconds." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The duration since the lineage began, in milliseconds." + }, + "eventType" : { + "type" : "string", + "description" : "The type of the event." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile for the event." + }, + "fileSize" : { + "type" : "string", + "description" : "The size of the flowfile for the event." + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the flowfile in bytes for the event." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the event originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the event originated." + }, + "groupId" : { + "type" : "string", + "description" : "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." + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component that generated the event." + }, + "componentType" : { + "type" : "string", + "description" : "The type of the component that generated the event." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component that generated the event." + }, + "sourceSystemFlowFileId" : { + "type" : "string", + "description" : "The source system flowfile id." + }, + "alternateIdentifierUri" : { + "type" : "string", + "description" : "The alternate identifier uri for the fileflow for the event." + }, + "attributes" : { + "type" : "array", + "description" : "The attributes of the flowfile for the event.", + "items" : { + "$ref" : "#/definitions/AttributeDTO" + } + }, + "parentUuids" : { + "type" : "array", + "description" : "The parent uuids for the event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The child uuids for the event.", + "items" : { + "type" : "string" + } + }, + "transitUri" : { + "type" : "string", + "description" : "The source/destination system uri if the event was a RECEIVE/SEND." + }, + "relationship" : { + "type" : "string", + "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." + }, + "details" : { + "type" : "string", + "description" : "The event details." + }, + "contentEqual" : { + "type" : "boolean", + "description" : "Whether the input and output content claim is the same." + }, + "inputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the input content is still available." + }, + "inputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the input content claim lives." + }, + "inputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the input content claim lives." + }, + "inputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the input content claim." + }, + "inputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the input content claim where the flowfiles content begins." + }, + "inputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the input content claim formatted." + }, + "inputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the intput content claim in bytes." + }, + "outputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the output content is still available." + }, + "outputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the output content claim lives." + }, + "outputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the output content claim lives." + }, + "outputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the output content claim." + }, + "outputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the output content claim where the flowfiles content begins." + }, + "outputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the output content claim formatted." + }, + "outputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the output content claim in bytes." + }, + "replayAvailable" : { + "type" : "boolean", + "description" : "Whether or not replay is available." + }, + "replayExplanation" : { + "type" : "string", + "description" : "Explanation as to why replay is unavailable." + }, + "sourceConnectionIdentifier" : { + "type" : "string", + "description" : "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." + } + } + }, + "ProvenanceEventEntity" : { + "type" : "object", + "properties" : { + "provenanceEvent" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "xml" : { + "name" : "provenanceEventEntity" + } + }, + "ProvenanceLinkDTO" : { + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "The source node id of the link." + }, + "targetId" : { + "type" : "string", + "description" : "The target node id of the link." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The flowfile uuid that traversed the link." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the link (based on the destination)." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of this link in milliseconds." + } + } + }, + "ProvenanceNodeDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile associated with the provenance event." + }, + "parentUuids" : { + "type" : "array", + "description" : "The uuid of the parent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The uuid of the childrent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "clusterNodeIdentifier" : { + "type" : "string", + "description" : "The identifier of the node that this event/flowfile originated from." + }, + "type" : { + "type" : "string", + "description" : "The type of the node.", + "enum" : [ "FLOWFILE", "EVENT" ] + }, + "eventType" : { + "type" : "string", + "description" : "If the type is EVENT, this is the type of event." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the node in milliseconds." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node formatted." + } + } + }, + "ProvenanceOptionsDTO" : { + "type" : "object", + "properties" : { + "searchableFields" : { + "type" : "array", + "description" : "The available searchable field for the NiFi.", + "items" : { + "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" + } + } + } + }, + "ProvenanceOptionsEntity" : { + "type" : "object", + "properties" : { + "provenanceOptions" : { + "$ref" : "#/definitions/ProvenanceOptionsDTO" + } + }, + "xml" : { + "name" : "provenanceOptionsEntity" + } + }, + "ProvenanceRequestDTO" : { + "type" : "object", + "properties" : { + "searchTerms" : { + "type" : "object", + "description" : "The search terms used to perform the search.", + "additionalProperties" : { + "type" : "string" + } + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node in the cluster where this provenance originated." + }, + "startDate" : { + "type" : "string", + "description" : "The earliest event time to include in the query." + }, + "endDate" : { + "type" : "string", + "description" : "The latest event time to include in the query." + }, + "minimumFileSize" : { + "type" : "string", + "description" : "The minimum file size to include in the query." + }, + "maximumFileSize" : { + "type" : "string", + "description" : "The maximum file size to include in the query." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of results to include." + }, + "summarize" : { + "type" : "boolean", + "description" : "Whether or not to summarize provenance events returned. This property is false by default." + }, + "incrementalResults" : { + "type" : "boolean", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." + } + } + }, + "ProvenanceResultsDTO" : { + "type" : "object", + "properties" : { + "provenanceEvents" : { + "type" : "array", + "description" : "The provenance events that matched the search criteria.", + "items" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "total" : { + "type" : "string", + "description" : "The total number of results formatted." + }, + "totalCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of results." + }, + "generated" : { + "type" : "string", + "description" : "Then the search was performed." + }, + "oldestEvent" : { + "type" : "string", + "description" : "The oldest event available in the provenance repository." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the server that's used for event time." + }, + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while performing the provenance request.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ProvenanceSearchableFieldDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the searchable field." + }, + "field" : { + "type" : "string", + "description" : "The searchable field." + }, + "label" : { + "type" : "string", + "description" : "The label for the searchable field." + }, + "type" : { + "type" : "string", + "description" : "The type of the searchable field." + } + } + }, + "QueueSizeDTO" : { + "type" : "object", + "properties" : { + "byteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of objects in a queue." + }, + "objectCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The count of objects in a queue." + } + } + }, + "RegistryClientEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RegistryDTO" + } + }, + "xml" : { + "name" : "registryClientEntity" + } + }, + "RegistryClientsEntity" : { + "type" : "object", + "properties" : { + "registries" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } + }, + "xml" : { + "name" : "registryClientsEntity" + } + }, + "RegistryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The registry identifier" + }, + "name" : { + "type" : "string", + "description" : "The registry name" + }, + "description" : { + "type" : "string", + "description" : "The registry description" + }, + "uri" : { + "type" : "string", + "description" : "The registry URI" + } + } + }, + "RelationshipDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The relationship name." + }, + "description" : { + "type" : "string", + "description" : "The relationship description." + }, + "autoTerminate" : { + "type" : "boolean", + "description" : "Whether or not flowfiles sent to this relationship should auto terminate." + } + } + }, + "RemotePortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the RemotePort.", + "enum" : [ "TRANSMITTING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupContentsDTO" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "description" : "The input ports to which data can be sent.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports from which data can be retrieved.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + } + } + }, + "RemoteProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "targetUri" : { + "type" : "string", + "description" : "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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "targetSecure" : { + "type" : "boolean", + "description" : "Whether the target is running securely." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the remote process group." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string" + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "authorizationIssues" : { + "type" : "array", + "description" : "Any remote authorization issues for the remote process group.", + "items" : { + "type" : "string" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote process group is actively transmitting." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "activeRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote input ports." + }, + "inactiveRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote input ports." + }, + "activeRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote output ports." + }, + "inactiveRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote output ports." + }, + "flowRefreshed" : { + "type" : "string", + "description" : "The timestamp when this remote process group was last refreshed." + }, + "contents" : { + "description" : "The contents of the remote process group. Will contain available input/output ports.", + "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" + } + } + }, + "RemoteProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + }, + "status" : { + "description" : "The status of the remote process group.", + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupEntity" + } + }, + "RemoteProcessGroupPortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "targetId" : { + "type" : "string", + "description" : "The id of the target port." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the target port." + }, + "comments" : { + "type" : "string", + "description" : "The comments as configured on the target port." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote port is configured for transmission." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "exists" : { + "type" : "boolean", + "description" : "Whether the target port exists." + }, + "targetRunning" : { + "type" : "boolean", + "description" : "Whether the target port is running." + }, + "connected" : { + "type" : "boolean", + "description" : "Whether the port has either an incoming or outgoing connection." + }, + "batchSettings" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSettingsDTO" + } + } + }, + "RemoteProcessGroupPortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "remoteProcessGroupPort" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupPortEntity" + } + }, + "RemoteProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" + } + } + } + }, + "RemoteProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroupStatus" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "remoteProcessGroupStatusEntity" + } + }, + "RemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group the remote process group resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the remote process group." + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." + }, + "sent" : { + "type" : "string", + "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." + }, + "received" : { + "type" : "string", + "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." + } + } + }, + "RemoteProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "remoteProcessGroupStatusSnapshot" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "remoteProcessGroupsEntity" + } + }, + "ReportingTaskDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the reporting task." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the reporting task." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the reporting task.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "comments" : { + "type" : "string", + "description" : "The comments of the reporting task." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the reporting task persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the reporting task requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the reporting task has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the reporting task has multiple versions available." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "The default scheduling period for the different scheduling strategies.", + "additionalProperties" : { + "type" : "string" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the reporting task.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the reporting tasks properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the reporting task." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the reporting task." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ReportingTaskEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ReportingTaskDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ReportingTask.", + "readOnly" : true, + "$ref" : "#/definitions/ReportingTaskStatusDTO" + } + }, + "xml" : { + "name" : "reportingTaskEntity" + } + }, + "ReportingTaskRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ReportingTask.", + "enum" : [ "RUNNING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ReportingTaskStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ReportingTask", + "readOnly" : true, + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ReportingTaskTypesEntity" : { + "type" : "object", + "properties" : { + "reportingTaskTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "reportingTaskTypesEntity" + } + }, + "ReportingTasksEntity" : { + "type" : "object", + "properties" : { + "reportingTasks" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } + }, + "xml" : { + "name" : "reportingTasksEntity" + } + }, + "RequiredPermissionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The required sub-permission necessary for this restriction." + }, + "label" : { + "type" : "string", + "description" : "The label for the required sub-permission necessary for this restriction." + } + } + }, + "ResourceDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource." + }, + "name" : { + "type" : "string", + "description" : "The name of the resource." + } + } + }, + "ResourcesEntity" : { + "type" : "object", + "properties" : { + "resources" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ResourceDTO" + } + } + }, + "xml" : { + "name" : "resourcesEntity" + } + }, + "RevisionDTO" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "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" + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the flow.", + "readOnly" : true + } + } + }, + "ScheduleComponentsEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "scheduleComponentEntity" + } + }, + "SearchResultGroupDTO" : { + "type" : "object", + "required" : [ "id" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The name of the group." + } + } + }, + "SearchResultsDTO" : { + "type" : "object", + "properties" : { + "processorResults" : { + "type" : "array", + "description" : "The processors that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "connectionResults" : { + "type" : "array", + "description" : "The connections that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "processGroupResults" : { + "type" : "array", + "description" : "The process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "inputPortResults" : { + "type" : "array", + "description" : "The input ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "outputPortResults" : { + "type" : "array", + "description" : "The output ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "remoteProcessGroupResults" : { + "type" : "array", + "description" : "The remote process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "funnelResults" : { + "type" : "array", + "description" : "The funnels that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterContextResults" : { + "type" : "array", + "description" : "The parameter contexts that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterResults" : { + "type" : "array", + "description" : "The parameters that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + } + } + }, + "SearchResultsEntity" : { + "type" : "object", + "properties" : { + "searchResultsDTO" : { + "$ref" : "#/definitions/SearchResultsDTO" + } + }, + "xml" : { + "name" : "searchResultsEntity" + } + }, + "SnippetDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the snippet." + }, + "uri" : { + "type" : "string", + "description" : "The URI of the snippet." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The group id for the components in the snippet." + }, + "processGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "remoteProcessGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "processors" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "inputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "outputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "connections" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "labels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "funnels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + } + } + }, + "SnippetEntity" : { + "type" : "object", + "properties" : { + "snippet" : { + "description" : "The snippet.", + "$ref" : "#/definitions/SnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "snippetEntity" + } + }, + "StartVersionControlRequestEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "startVersionControlRequestEntity" + } + }, + "StateEntryDTO" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string", + "description" : "The key for this state." + }, + "value" : { + "type" : "string", + "description" : "The value for this state." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the state originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the state originated." + } + } + }, + "StateMapDTO" : { + "type" : "object", + "properties" : { + "scope" : { + "type" : "string", + "description" : "The scope of this StateMap." + }, + "totalEntryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." + }, + "state" : { + "type" : "array", + "description" : "The state.", + "items" : { + "$ref" : "#/definitions/StateEntryDTO" + } + } + } + }, + "StatusDescriptorDTO" : { + "type" : "object", + "properties" : { + "field" : { + "type" : "string", + "description" : "The name of the status field." + }, + "label" : { + "type" : "string", + "description" : "The label for the status field." + }, + "description" : { + "type" : "string", + "description" : "The description of the status field." + }, + "formatter" : { + "type" : "string", + "description" : "The formatter for the status descriptor." + } + } + }, + "StatusHistoryDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When the status history was generated." + }, + "componentDetails" : { + "type" : "object", + "description" : "A Map of key/value pairs that describe the component that the status history belongs to", + "additionalProperties" : { + "type" : "string" + } + }, + "fieldDescriptors" : { + "type" : "array", + "description" : "The Descriptors that provide information on each of the metrics provided in the status history", + "items" : { + "$ref" : "#/definitions/StatusDescriptorDTO" + } + }, + "aggregateSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeStatusSnapshotsDTO" + } + } + } + }, + "StatusHistoryEntity" : { + "type" : "object", + "properties" : { + "statusHistory" : { + "$ref" : "#/definitions/StatusHistoryDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "statusHistoryEntity" + } + }, + "StatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of the snapshot." + }, + "statusMetrics" : { + "type" : "object", + "description" : "The status metrics.", + "additionalProperties" : { + "type" : "integer", + "format" : "int64" + } + } + } + }, + "StorageUsageDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." + }, + "freeSpace" : { + "type" : "string", + "description" : "Amount of free space." + }, + "totalSpace" : { + "type" : "string", + "description" : "Amount of total space." + }, + "usedSpace" : { + "type" : "string", + "description" : "Amount of used space." + }, + "freeSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of free space." + }, + "totalSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of total space." + }, + "usedSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of used space." + }, + "utilization" : { + "type" : "string", + "description" : "Utilization of this storage location." + } + } + }, + "StreamingOutput" : { + "type" : "object" + }, + "SubmitReplayRequestEntity" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event identifier" + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier of the node where to submit the replay request." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "SystemDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" + } + } + } + }, + "SystemDiagnosticsEntity" : { + "type" : "object", + "properties" : { + "systemDiagnostics" : { + "$ref" : "#/definitions/SystemDiagnosticsDTO" + } + }, + "xml" : { + "name" : "systemDiagnosticsEntity" + } + }, + "SystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "totalNonHeap" : { + "type" : "string", + "description" : "Total size of non heap." + }, + "totalNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes allocated to the JVM not used for heap" + }, + "usedNonHeap" : { + "type" : "string", + "description" : "Amount of use non heap." + }, + "usedNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes used by the JVM not in the heap space" + }, + "freeNonHeap" : { + "type" : "string", + "description" : "Amount of free non heap." + }, + "freeNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of free non-heap bytes available to the JVM" + }, + "maxNonHeap" : { + "type" : "string", + "description" : "Maximum size of non heap." + }, + "maxNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" + }, + "nonHeapUtilization" : { + "type" : "string", + "description" : "Utilization of non heap." + }, + "totalHeap" : { + "type" : "string", + "description" : "Total size of heap." + }, + "totalHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of bytes that are available for the JVM heap to use" + }, + "usedHeap" : { + "type" : "string", + "description" : "Amount of used heap." + }, + "usedHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of JVM heap that are currently being used" + }, + "freeHeap" : { + "type" : "string", + "description" : "Amount of free heap." + }, + "freeHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" + }, + "maxHeap" : { + "type" : "string", + "description" : "Maximum size of heap." + }, + "maxHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that can be used by the JVM" + }, + "heapUtilization" : { + "type" : "string", + "description" : "Utilization of heap." + }, + "availableProcessors" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of available processors if supported by the underlying system." + }, + "processorLoadAverage" : { + "type" : "number", + "format" : "double", + "description" : "The processor load average if supported by the underlying system." + }, + "totalThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of threads." + }, + "daemonThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of daemon threads." + }, + "uptime" : { + "type" : "string", + "description" : "The uptime of the Java virtual machine" + }, + "flowFileRepositoryStorageUsage" : { + "description" : "The flowfile repository storage usage.", + "$ref" : "#/definitions/StorageUsageDTO" + }, + "contentRepositoryStorageUsage" : { + "type" : "array", + "description" : "The content repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "provenanceRepositoryStorageUsage" : { + "type" : "array", + "description" : "The provenance repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "garbageCollection" : { + "type" : "array", + "description" : "The garbage collection details.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/GarbageCollectionDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "When the diagnostics were generated." + }, + "versionInfo" : { + "description" : "The nifi, os, java, and build version information", + "$ref" : "#/definitions/VersionInfoDTO" + } + } + }, + "TemplateDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI for the template." + }, + "id" : { + "type" : "string", + "description" : "The id of the template." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the Process Group that the template belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when this template was created." + }, + "encodingVersion" : { + "type" : "string", + "xml" : { + "name" : "encoding-version", + "attribute" : true + }, + "description" : "The encoding version of this template." + }, + "snippet" : { + "description" : "The contents of the template.", + "$ref" : "#/definitions/FlowSnippetDTO" + } + }, + "xml" : { + "name" : "template" + } + }, + "TemplateEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "template" : { + "$ref" : "#/definitions/TemplateDTO" + } + }, + "xml" : { + "name" : "templateEntity" + } + }, + "TemplatesEntity" : { + "type" : "object", + "properties" : { + "templates" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + } + }, + "xml" : { + "name" : "templatesEntity" + } + }, + "TenantDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + } + } + }, + "TenantEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/TenantDTO" + } + }, + "xml" : { + "name" : "tenantEntity" + } + }, + "TenantsEntity" : { + "type" : "object", + "properties" : { + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + }, + "xml" : { + "name" : "tenantsEntity" + } + }, + "TransactionResultEntity" : { + "type" : "object", + "properties" : { + "flowFileSent" : { + "type" : "integer", + "format" : "int32" + }, + "responseCode" : { + "type" : "integer", + "format" : "int32" + }, + "message" : { + "type" : "string" + } + }, + "xml" : { + "name" : "transactionResultEntity" + } + }, + "UpdateControllerServiceReferenceRequestEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The identifier of the Controller Service." + }, + "state" : { + "type" : "string", + "description" : "The new state of the references for the controller service.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] + }, + "referencingComponentRevisions" : { + "type" : "object", + "description" : "The revisions for all referencing components.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "updateControllerServiceReferenceRequestEntity" + } + }, + "UserDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies this user belongs to.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummaryEntity" + } + } + } + }, + "UserEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserDTO" + } + }, + "xml" : { + "name" : "userEntity" + } + }, + "UserGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "users" : { + "type" : "array", + "description" : "The users that belong to the user group.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "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.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } + } + }, + "UserGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserGroupDTO" + } + }, + "xml" : { + "name" : "userGroupEntity" + } + }, + "UserGroupsEntity" : { + "type" : "object", + "properties" : { + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } + }, + "xml" : { + "name" : "userGroupsEntity" + } + }, + "UsersEntity" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserEntity" + } + } + }, + "xml" : { + "name" : "usersEntity" + } + }, + "VariableDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the variable" + }, + "value" : { + "type" : "string", + "description" : "The value of the variable" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group where this Variable is defined", + "readOnly" : true + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableEntity" : { + "type" : "object", + "properties" : { + "variable" : { + "description" : "The variable information", + "$ref" : "#/definitions/VariableDTO" + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "variableEntity" + } + }, + "VariableRegistryDTO" : { + "type" : "object", + "properties" : { + "variables" : { + "type" : "array", + "description" : "The variables that are available in this Variable Registry", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VariableEntity" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this Variable Registry belongs to" + } + } + }, + "VariableRegistryEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision of the Process Group that the Variable Registry belongs to", + "$ref" : "#/definitions/RevisionDTO" + }, + "variableRegistry" : { + "description" : "The Variable Registry.", + "$ref" : "#/definitions/VariableRegistryDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "variableRegistryEntity" + } + }, + "VariableRegistryUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableRegistryUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Variable Registry Update Request", + "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "variableRegistryUpdateRequestEntity" + } + }, + "VariableRegistryUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "VersionControlComponentMappingEntity" : { + "type" : "object", + "properties" : { + "versionControlComponentMapping" : { + "type" : "object", + "description" : "The mapping of Versioned Component Identifiers to instance ID's", + "additionalProperties" : { + "type" : "string" + } + }, + "processGroupRevision" : { + "description" : "The revision of the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlComponentMappingEntity" + } + }, + "VersionControlInformationDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that is under version control" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is stored in" + }, + "registryName" : { + "type" : "string", + "description" : "The name of the registry that the flow is stored in", + "readOnly" : true + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket that the flow is stored in" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket that the flow is stored in", + "readOnly" : true + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "flowDescription" : { + "type" : "string", + "description" : "The description of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "state" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "stateExplanation" : { + "type" : "string", + "description" : "Explanation of why the group is in the specified state", + "readOnly" : true + } + } + }, + "VersionControlInformationEntity" : { + "type" : "object", + "properties" : { + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "processGroupRevision" : { + "description" : "The Revision for the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionControlInformationEntity" + } + }, + "VersionInfoDTO" : { + "type" : "object", + "properties" : { + "niFiVersion" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "javaVendor" : { + "type" : "string", + "description" : "Java JVM vendor" + }, + "javaVersion" : { + "type" : "string", + "description" : "Java version" + }, + "osName" : { + "type" : "string", + "description" : "Host operating system name" + }, + "osVersion" : { + "type" : "string", + "description" : "Host operating system version" + }, + "osArchitecture" : { + "type" : "string", + "description" : "Host operating system architecture" + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Build timestamp" + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "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." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/Bundle" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "readOnly" : true, + "minimum" : 0 + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDTO" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is tracked to" + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket where the flow is stored" + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "description" : { + "type" : "string", + "description" : "A description of the flow" + }, + "comments" : { + "type" : "string", + "description" : "Comments for the changeset" + }, + "action" : { + "type" : "string", + "description" : "The action being performed", + "enum" : [ "COMMIT", "FORCE_COMMIT" ] + } + } + }, + "VersionedFlowEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + } + }, + "xml" : { + "name" : "versionedFlowEntity" + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "required" : [ "flowContents", "snapshotMetadata" ], + "properties" : { + "snapshotMetadata" : { + "description" : "The metadata for this snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "flowContents" : { + "description" : "The contents of the versioned flow", + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterContexts" : { + "type" : "object", + "description" : "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.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "flow" : { + "description" : "The flow this snapshot is for", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlow" + }, + "bucket" : { + "description" : "The bucket where the flow is located", + "readOnly" : true, + "$ref" : "#/definitions/Bucket" + }, + "latest" : { + "type" : "boolean" + } + } + }, + "VersionedFlowSnapshotEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshot" : { + "description" : "The versioned flow snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + }, + "updateDescendantVersionedFlows" : { + "type" : "boolean", + "description" : "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." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionedFlowSnapshotEntity" + } + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to." + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "readOnly" : true + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + } + } + }, + "VersionedFlowSnapshotMetadataEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadata" : { + "description" : "The collection of versioned flow snapshot metadata", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataEntity" + } + }, + "VersionedFlowSnapshotMetadataSetEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadataSet" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataSetEntity" + } + }, + "VersionedFlowUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this request has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this request failed, or null if this request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + }, + "versionControlInformation" : { + "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", + "readOnly" : true, + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "VersionedFlowUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Versioned Flow Update Request", + "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "versionedFlowUpdateRequestEntity" + } + }, + "VersionedFlowsEntity" : { + "type" : "object", + "properties" : { + "versionedFlows" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowsEntity" + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the context" + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "The type of Processor" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + } + } +} \ No newline at end of file diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index f7a94c11..c7e8f401 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,7 +2,7 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.10.0 + image: apache/nifi:1.11.0 container_name: nifi hostname: nifi ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index c782fef2..382ae0fe 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.1' services: secure-nifi: - image: apache/nifi:1.10.0 + image: apache/nifi:1.11.0 container_name: secure-nifi hostname: secure-nifi ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index 1d961e08..187de16f 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -25,7 +25,7 @@ services: ports: - "10192:8080" nifi: - image: apache/nifi:1.10.0 + image: apache/nifi:1.11.0 container_name: nifi hostname: nifi ports: From 1e4ce3829ef02791fd34cb0656bec11b565b83fd Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Tue, 10 Mar 2020 14:22:23 +0000 Subject: [PATCH 24/40] Updated NiFi client to 1.11 Updated docker files to latest 1.11 build Minor documentation fixes --- nipyapi/canvas.py | 2 +- nipyapi/security.py | 7 +++++-- resources/docker/latest/docker-compose.yml | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 506158da..9ad35f4c 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -121,7 +121,7 @@ def get_process_group_status(pg_id='root', detail='names'): def get_process_group(identifier, identifier_type='name'): """ Filters the list of all process groups against a given identifier string - occuring in a given identifier_type field. + occurring in a given identifier_type field. Args: identifier (str): the string to filter the list for diff --git a/nipyapi/security.py b/nipyapi/security.py index d9c13be7..97f21831 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -145,7 +145,8 @@ def create_service_user_group(identity, service='nifi', Args: 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 + 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: @@ -753,7 +754,9 @@ def bootstrap_security_policies(service, user_identity=None, """ assert service in _valid_services, "service not in %s" % _valid_services if user_identity is not None: - assert user_identity in [nipyapi.nifi.UserEntity, nipyapi.registry.User] + assert user_identity in [ + nipyapi.nifi.UserEntity, nipyapi.registry.User + ] if 'nifi' in service: rpg_id = nipyapi.canvas.get_root_pg_id() if user_identity is None and group_identity is None: diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index c7e8f401..82d9cc30 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,7 +2,7 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.11.0 + image: apache/nifi:1.11.3 container_name: nifi hostname: nifi ports: From d463792eade3b0aeeb46529f5f986a4ec97d2970 Mon Sep 17 00:00:00 2001 From: "pyup.io bot" Date: Wed, 11 Mar 2020 19:00:15 +0200 Subject: [PATCH 25/40] Update ruamel.yaml from 0.16.5 to 0.16.10 (#178) --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 7e6b8ec7..05d1eae3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -15,7 +15,7 @@ requests[security]>=2.18 # urllib3 is handled by requests # Import Export and Utils implementation -ruamel.yaml==0.16.5 +ruamel.yaml==0.16.10 deepdiff>=3.3.0,<4.0 # pyup: ignore # Demo deployment automation From b19c45ce5a05a78b92f73a667502bfcb705fbe95 Mon Sep 17 00:00:00 2001 From: rsaggino <47176531+rsaggino@users.noreply.github.com> Date: Mon, 16 Mar 2020 15:06:53 +0100 Subject: [PATCH 26/40] Fix force pg delete (#181) * Fix check version in canvas * Fixed forceful PG removal * Update Docker definitions to 1.11.3 Linting changes to code layout Change Controllers logic for <=1.2.0, instead of <=1.1.2 Handle duplicate controllers in list_all_controllers for old versions of NiFi Add tests for list_all_controllers Fixes #170 Fixes #180 Co-authored-by: Daniel Chaffelson --- .vscode/settings.json | 3 + nipyapi/canvas.py | 60 +++++++++++++++++--- nipyapi/security.py | 6 +- resources/docker/latest/docker-compose.yml | 2 +- resources/docker/secure/docker-compose.yml | 2 +- resources/docker/tox-full/docker-compose.yml | 2 +- tests/conftest.py | 2 +- tests/test_canvas.py | 39 +++++++++++-- 8 files changed, 97 insertions(+), 19 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..500bc700 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "python.linting.pylintEnabled": true +} \ No newline at end of file diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 506158da..9935e108 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -26,7 +26,7 @@ 'list_all_funnels', 'list_all_remote_process_groups', 'delete_funnel', 'get_remote_process_group', 'update_process_group', 'create_funnel', 'create_remote_process_group', 'delete_remote_process_group', - 'set_remote_process_group_transmission' + 'set_remote_process_group_transmission', 'get_pg_parents_ids' ] log = logging.getLogger(__name__) @@ -281,6 +281,7 @@ def list_all_processors(pg_id='root'): assert isinstance(pg_id, six.string_types), "pg_id should be a string" if nipyapi.utils.check_version('1.7.0') <= 0: + # Case where NiFi > 1.7.0 targets = nipyapi.nifi.ProcessGroupsApi().get_processors( id=pg_id, include_descendant_groups=True @@ -378,15 +379,25 @@ def delete_process_group(process_group, force=False, refresh=True): ) except nipyapi.nifi.rest.ApiException as e: if force: + # Retrieve parent process group + parent_pg_id = nipyapi.canvas.get_process_group(pg_id, 'id')\ + .component.parent_group_id # Stop, drop, and roll. purge_process_group(target, stop=True) # Remove inbound connections - for con in list_all_connections(): + for con in list_all_connections(parent_pg_id): if pg_id in [con.destination_group_id, con.source_group_id]: delete_connection(con) - # Stop all Controller Services - for x in list_all_controllers(process_group.id): - delete_controller(x, True) + # Stop all Controller Services ONLY inside the PG + controllers_list = list_all_controllers(pg_id) + removed_controllers_id = [] + parent_pgs_id = get_pg_parents_ids(pg_id) + for x in controllers_list: + if x.component.id not in removed_controllers_id: + if x.component.parent_group_id not in parent_pgs_id: + delete_controller(x, True) + removed_controllers_id.append(x.component.id) + # Remove templates for template in nipyapi.templates.list_all_templates(native=False): if target.id == template.template.group_id: @@ -1087,16 +1098,25 @@ def list_all_controllers(pg_id='root', descendants=True): assert isinstance(descendants, bool) handle = nipyapi.nifi.FlowApi() # Testing shows that descendant doesn't work on NiFi-1.1.2 - if nipyapi.utils.check_version('1.1.2') < 1: + # Or 1.2.0, despite the descendants option being available + if nipyapi.utils.check_version('1.2.0') >= 0: + # Case where NiFi <= 1.2.0 out = [] if descendants: pgs = list_all_process_groups(pg_id) else: pgs = [get_process_group(pg_id, 'id')] for pg in pgs: - out += handle.get_controller_services_from_group( + new_conts = handle.get_controller_services_from_group( pg.id).controller_services + # trim duplicates from inheritance + out += [ + x for x in new_conts + if x.id not in [y.id for y in out] + ] else: + # Case where NiFi > 1.2.0 + # duplicate trim already handled by server out = handle.get_controller_services_from_group( pg_id, include_descendant_groups=descendants @@ -1110,7 +1130,7 @@ def delete_controller(controller, force=False): Args: controller (ControllerServiceEntity): Target Controller to delete - force (bool): True to Disable the Controller before deletion + force (bool): True to attempt Disable the Controller before deletion Returns: (ControllerServiceEntity) @@ -1199,7 +1219,8 @@ def _schedule_controller_state(cont_id, tgt_state): if refresh: controller = nipyapi.canvas.get_controller(controller.id, 'id') assert isinstance(controller, nipyapi.nifi.ControllerServiceEntity) - if nipyapi.utils.check_version('1.1.2') < 1: + if nipyapi.utils.check_version('1.2.0') >= 0: + # Case where NiFi <= 1.2.0 result = update_controller( controller=controller, update=nipyapi.nifi.ControllerServiceDTO( @@ -1207,6 +1228,7 @@ def _schedule_controller_state(cont_id, tgt_state): ) ) else: + # Case where NiFi > 1.2.0 result = handle.update_run_status( id=controller.id, body=nipyapi.nifi.ControllerServiceRunStatusEntity( @@ -1535,3 +1557,23 @@ def delete_funnel(funnel, refresh=True): id=funnel.id, version=funnel.revision.version ) + + +def get_pg_parents_ids(pg_id): + """ + Retrieve the ids of the parent Process Groups. + + Args: + pg_id (str): Process group id + + Returns: + (list) List of ids of the input PG parents + """ + parent_groups = [] + while pg_id: + pg_id = nipyapi.canvas.get_process_group(pg_id, 'id') \ + .component.parent_group_id + parent_groups.append(pg_id) + # Removing the None value + parent_groups.pop() + return parent_groups diff --git a/nipyapi/security.py b/nipyapi/security.py index d9c13be7..a4f15e98 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -145,7 +145,8 @@ def create_service_user_group(identity, service='nifi', Args: 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 + 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: @@ -752,8 +753,9 @@ def bootstrap_security_policies(service, user_identity=None, """ assert service in _valid_services, "service not in %s" % _valid_services + valid_ident_obj = [nipyapi.nifi.UserEntity, nipyapi.registry.User] if user_identity is not None: - assert user_identity in [nipyapi.nifi.UserEntity, nipyapi.registry.User] + assert user_identity in valid_ident_obj if 'nifi' in service: rpg_id = nipyapi.canvas.get_root_pg_id() if user_identity is None and group_identity is None: diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index f7a94c11..82d9cc30 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,7 +2,7 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.10.0 + image: apache/nifi:1.11.3 container_name: nifi hostname: nifi ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index c782fef2..86d232a1 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.1' services: secure-nifi: - image: apache/nifi:1.10.0 + image: apache/nifi:1.11.3 container_name: secure-nifi hostname: secure-nifi ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index 1d961e08..eda55f05 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -25,7 +25,7 @@ services: ports: - "10192:8080" nifi: - image: apache/nifi:1.10.0 + image: apache/nifi:1.11.3 container_name: nifi hostname: nifi ports: diff --git a/tests/conftest.py b/tests/conftest.py index c4f782a7..76da6856 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -177,7 +177,7 @@ def regress_flow_reg(request): nipyapi.utils.set_endpoint(request.param[0], True, True) # Set paired NiFi connection nipyapi.utils.set_endpoint(request.param[2], True, True) - # because pytest won't let you eaily cascade parameters through fixtures + # because pytest won't let you easily cascade parameters through fixtures # we set the docker URI in the config for retrieval later on nipyapi.config.registry_local_name = request.param[1] diff --git a/tests/test_canvas.py b/tests/test_canvas.py index 5bf54a9a..66c33125 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -332,7 +332,6 @@ def test_update_variable_registry(fix_pg): _ = canvas.update_variable_registry(test_pg, '') - def test_purge_connection(): # TODO: Waiting for create_connection to generate fixture pass @@ -469,15 +468,40 @@ def test_list_all_controller_types(regress_nifi): def test_list_all_controllers(regress_nifi, fix_pg, fix_cont): - f_c1 = fix_cont(parent_pg=fix_pg.generate()) + f_pg_1 = fix_pg.generate() + f_pg_2 = fix_pg.generate(parent_pg=f_pg_1) + f_c1 = fix_cont() + f_c2 = fix_cont(parent_pg=f_pg_1) + f_c3 = fix_cont(parent_pg=f_pg_2) assert isinstance(f_c1, nifi.ControllerServiceEntity) + assert isinstance(f_c2, nifi.ControllerServiceEntity) + assert isinstance(f_c3, nifi.ControllerServiceEntity) + # Find all and l0 l1 and l2 r1 = canvas.list_all_controllers() - assert f_c1.id in [x.id for x in r1] + assert all(y.id in [x.id for x in r1] for y in [f_c1, f_c2, f_c3]) + # find just l0 r2 = canvas.list_all_controllers( pg_id='root', descendants=False) r2 = [x for x in r2 if conftest.test_basename in x.component.name] - assert not r2 + assert len(r2) == 1 + assert f_c1.id in [x.id for x in r2] + # find just l1 + r3 = canvas.list_all_controllers( + pg_id=f_pg_1.id, + descendants=False) + r3 = [x for x in r3 if conftest.test_basename in x.component.name] + assert len(r3) == 2 + assert all(y.id in [x.id for x in r3] for y in [f_c1, f_c2]) + # Find l1 and l2 + # This will fail if duplicates are introduced in the listing + r4 = canvas.list_all_controllers( + pg_id=f_pg_1.id, + descendants=True) + r4 = [x for x in r4 if conftest.test_basename in x.component.name] + assert len(r4) == 3 + assert all(y.id in [x.id for x in r4] for y in [f_c1, f_c2, f_c3]) + # test errors with pytest.raises(AssertionError): _ = canvas.list_all_controllers(pg_id=['bob']) with pytest.raises(AssertionError): @@ -544,6 +568,13 @@ def test_delete_controller(regress_nifi, fix_pg, fix_cont): assert f_c2.revision is not None r2 = canvas.delete_controller(f_c2, True) assert r2.revision is None + # Test for only delete within a PG + f_c_root = fix_cont() + f_c_pg = fix_cont(parent_pg=f_pg) + r3 = canvas.delete_process_group(f_pg) + assert r3.revision is None + r4 = canvas.get_controller(identifier=f_c_root.id, identifier_type='id') + assert r4.revision is not None def test_update_controller(regress_nifi, fix_pg, fix_cont): From 6c860d948700028561667bc6ce884eb4ebdaaf40 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Tue, 17 Mar 2020 08:48:03 +0000 Subject: [PATCH 27/40] Moved deepdiff from install requirements to development as it is only used in testing. --- requirements.txt | 3 +-- requirements_dev.txt | 1 + 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 05d1eae3..574e6d9f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -12,11 +12,10 @@ lxml>=4.1.1,<4.4.0 # pyup: ignore # Security and Connectivity requests[security]>=2.18 -# urllib3 is handled by requests +# urllib3, cryptography are handled by requests # Import Export and Utils implementation ruamel.yaml==0.16.10 -deepdiff>=3.3.0,<4.0 # pyup: ignore # Demo deployment automation docker>=2.5.1 diff --git a/requirements_dev.txt b/requirements_dev.txt index 362f9592..ab2c4dc9 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -19,6 +19,7 @@ pytest-runner>=2.12.1 nose>=1.3.7 pluggy>=0.3.1 pylint>=1.7.4 +deepdiff>=3.3.0,<4.0 # pyup: ignore # Docs Sphinx>=1.6.3 From c115237396a1dfa15cf1def783b321345a2fc633 Mon Sep 17 00:00:00 2001 From: Daniel Chaffelson Date: Tue, 17 Mar 2020 09:00:47 +0000 Subject: [PATCH 28/40] =?UTF-8?q?Bump=20version:=200.14.0=20=E2=86=92=200.?= =?UTF-8?q?14.1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- nipyapi/__init__.py | 2 +- setup.cfg | 2 +- setup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index 2ba4a796..5c97b46f 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.14.0' +__version__ = '0.14.1' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security'] diff --git a/setup.cfg b/setup.cfg index 1c245567..4e3be951 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.14.0 +current_version = 0.14.1 commit = True tag = True diff --git a/setup.py b/setup.py index 06eeee5a..ff621c83 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ with open('docs/history.rst') as history_file: history = history_file.read() -proj_version = '0.14.0' +proj_version = '0.14.1' with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() From e8a53b79a5e1a6b29446f43d2b23b6a3e60873f1 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Wed, 15 Apr 2020 13:43:59 +0100 Subject: [PATCH 29/40] Patch for authentication issue (#193) bumpversion to 0.14.3 Patch authentication issue to provide control for which authentication method is used in the config. Default is set to tokenAuth per previous behavior. --- .gitignore | 3 + .vscode/settings.json | 3 - docs/devnotes.rst | 2 +- nipyapi/__init__.py | 2 +- nipyapi/canvas.py | 31 ++++--- nipyapi/config.py | 9 ++ nipyapi/nifi/apis/access_api.py | 28 +++---- nipyapi/nifi/apis/connections_api.py | 6 +- nipyapi/nifi/apis/controller_api.py | 30 +++---- nipyapi/nifi/apis/controller_services_api.py | 18 ++-- nipyapi/nifi/apis/counters_api.py | 4 +- nipyapi/nifi/apis/data_transfer_api.py | 14 ++-- nipyapi/nifi/apis/flow_api.py | 82 +++++++++---------- nipyapi/nifi/apis/flowfile_queues_api.py | 16 ++-- nipyapi/nifi/apis/funnel_api.py | 6 +- nipyapi/nifi/apis/input_ports_api.py | 8 +- nipyapi/nifi/apis/labels_api.py | 6 +- nipyapi/nifi/apis/output_ports_api.py | 8 +- nipyapi/nifi/apis/parameter_contexts_api.py | 20 ++--- nipyapi/nifi/apis/policies_api.py | 10 +-- nipyapi/nifi/apis/process_groups_api.py | 64 +++++++-------- nipyapi/nifi/apis/processors_api.py | 18 ++-- nipyapi/nifi/apis/provenance_api.py | 14 ++-- nipyapi/nifi/apis/provenance_events_api.py | 8 +- .../nifi/apis/remote_process_groups_api.py | 18 ++-- nipyapi/nifi/apis/reporting_tasks_api.py | 14 ++-- nipyapi/nifi/apis/resources_api.py | 2 +- nipyapi/nifi/apis/site_to_site_api.py | 4 +- nipyapi/nifi/apis/snippets_api.py | 6 +- nipyapi/nifi/apis/system_diagnostics_api.py | 2 +- nipyapi/nifi/apis/templates_api.py | 4 +- nipyapi/nifi/apis/tenants_api.py | 22 ++--- nipyapi/nifi/apis/versions_api.py | 28 +++---- nipyapi/nifi/configuration.py | 25 ++++-- nipyapi/security.py | 43 ++++++---- nipyapi/templates.py | 2 +- nipyapi/utils.py | 19 +++-- .../client_gen/swagger_templates/api.mustache | 2 +- .../swagger_templates/configuration.mustache | 25 ++++-- resources/docker/latest/docker-compose.yml | 2 +- resources/docker/secure/docker-compose.yml | 2 +- resources/docker/tox-full/docker-compose.yml | 2 +- setup.cfg | 2 +- setup.py | 2 +- tests/conftest.py | 1 + 45 files changed, 350 insertions(+), 287 deletions(-) delete mode 100644 .vscode/settings.json diff --git a/.gitignore b/.gitignore index abb15a40..fc306a5c 100644 --- a/.gitignore +++ b/.gitignore @@ -154,3 +154,6 @@ crashlytics-build.properties fabric.properties /{envtmpdir}/ + +# Stupid OSX exclusions +/.vscode diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 500bc700..00000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "python.linting.pylintEnabled": true -} \ No newline at end of file diff --git a/docs/devnotes.rst b/docs/devnotes.rst index d3d3d3af..5524293d 100644 --- a/docs/devnotes.rst +++ b/docs/devnotes.rst @@ -38,7 +38,7 @@ 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 + 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 diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index 5c97b46f..32fdd24c 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.14.1' +__version__ = '0.14.3' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security'] diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 7c0a3f33..43964708 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -118,7 +118,7 @@ def get_process_group_status(pg_id='root', detail='names'): return raw -def get_process_group(identifier, identifier_type='name'): +def 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. @@ -126,6 +126,7 @@ def get_process_group(identifier, identifier_type='name'): Args: 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, @@ -135,13 +136,14 @@ def get_process_group(identifier, identifier_type='name'): assert isinstance(identifier, six.string_types) assert identifier_type in ['name', 'id'] with nipyapi.utils.rest_exceptions(): - if identifier_type == 'id': - # assuming unique fetch of pg id + if identifier_type == 'id' or identifier == 'root': + # assuming unique fetch of pg id, 'root' is special case # implementing separately to avoid recursing entire canvas out = nipyapi.nifi.ProcessGroupsApi().get_process_group(identifier) else: obj = list_all_process_groups() - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) + out = nipyapi.utils.filter_obj( + obj, identifier, identifier_type, greedy=greedy) return out @@ -213,7 +215,7 @@ def list_invalid_processors(pg_id='root', summary=False): assert isinstance(pg_id, six.string_types), "pg_id should be a string" assert isinstance(summary, bool) proc_list = [x for x in list_all_processors(pg_id) - if x.component.validation_errors is not None] + if x.component.validation_errors] if summary: out = [{'id': x.id, 'summary': x.component.validation_errors} for x in proc_list] @@ -525,7 +527,7 @@ def create_processor(parent_pg, processor, location, name=None, config=None): ) -def get_processor(identifier, identifier_type='name'): +def 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 @@ -534,6 +536,7 @@ def get_processor(identifier, identifier_type='name'): 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, @@ -546,7 +549,9 @@ def get_processor(identifier, identifier_type='name'): out = nipyapi.nifi.ProcessorsApi().get_processor(identifier) else: obj = list_all_processors() - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) + out = nipyapi.utils.filter_obj( + obj, identifier, identifier_type, greedy=greedy + ) return out @@ -1164,7 +1169,7 @@ def _del_cont(cont_id): return result -def update_controller(controller, update): +def update_controller(controller, update, refresh=True): """ Updates the Configuration of a Controller Service @@ -1172,6 +1177,7 @@ def update_controller(controller, update): controller (ControllerServiceEntity): Target Controller to update update (ControllerServiceDTO): Controller Service configuration object containing the new config params and properties + refresh (bool): True to refresh before applying Returns: (ControllerServiceEntity) @@ -1180,6 +1186,8 @@ def update_controller(controller, update): assert isinstance(controller, nipyapi.nifi.ControllerServiceEntity) assert isinstance(update, nipyapi.nifi.ControllerServiceDTO) # Insert the ID into the update + if refresh: + controller = get_controller(controller.id, 'id') update.id = controller.id return nipyapi.nifi.ControllerServicesApi().update_controller_service( id=controller.id, @@ -1250,7 +1258,8 @@ def _schedule_controller_state(cont_id, tgt_state): raise ValueError("Scheduling request timed out") -def get_controller(identifier, identifier_type='name', bool_response=False): +def get_controller(identifier, identifier_type='name', + bool_response=False, greedy=True): """ Retrieve a given Controller @@ -1259,6 +1268,7 @@ def get_controller(identifier, identifier_type='name', bool_response=False): 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 + greedy (bool): True for partial match, False for exact match Returns: @@ -1271,7 +1281,8 @@ def get_controller(identifier, identifier_type='name', bool_response=False): out = handle.get_controller_service(identifier) else: obj = list_all_controllers() - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) + out = nipyapi.utils.filter_obj( + obj, identifier, identifier_type, greedy=greedy) except nipyapi.nifi.rest.ApiException as e: if bool_response: return False diff --git a/nipyapi/config.py b/nipyapi/config.py index eb9eb1ce..ee496729 100644 --- a/nipyapi/config.py +++ b/nipyapi/config.py @@ -35,6 +35,15 @@ registry_config.host = 'http://' + default_host + ':18080/nifi-registry-api' +# Set Default Auth Types +# Set list to the Auth type you want to use +# Currently basicAuth trumps tokenAuth if both are enabled +default_auth = ['tokenAuth'] +# NiFi valid options: ['tokenAuth', 'basicAuth'] +# Registry valid options: ['tokenAuth', 'basicAuth', 'Authorization'] +nifi_config.enabled_auth = default_auth # tokenAuth was default before 0.14.2 + + # Set SSL Handling # When operating with self signed certs, your log can fill up with # unnecessary warnings diff --git a/nipyapi/nifi/apis/access_api.py b/nipyapi/nifi/apis/access_api.py index b6348dae..c7e7624e 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -130,7 +130,7 @@ def create_access_token_with_http_info(self, **kwargs): select_header_content_type(['application/x-www-form-urlencoded']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/token', 'POST', path_params, @@ -228,7 +228,7 @@ def create_access_token_from_ticket_with_http_info(self, **kwargs): select_header_content_type(['text/plain']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/kerberos', 'POST', path_params, @@ -326,7 +326,7 @@ def create_download_token_with_http_info(self, **kwargs): select_header_content_type(['application/x-www-form-urlencoded']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/download-token', 'POST', path_params, @@ -424,7 +424,7 @@ def create_ui_extension_token_with_http_info(self, **kwargs): select_header_content_type(['application/x-www-form-urlencoded']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/ui-extension-token', 'POST', path_params, @@ -522,7 +522,7 @@ def get_access_status_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access', 'GET', path_params, @@ -620,7 +620,7 @@ def get_login_config_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/config', 'GET', path_params, @@ -718,7 +718,7 @@ def knox_callback_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/knox/callback', 'GET', path_params, @@ -816,7 +816,7 @@ def knox_logout_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/knox/logout', 'GET', path_params, @@ -914,7 +914,7 @@ def knox_request_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/knox/request', 'GET', path_params, @@ -1012,7 +1012,7 @@ def log_out_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/logout', 'DELETE', path_params, @@ -1110,7 +1110,7 @@ def oidc_callback_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/oidc/callback', 'GET', path_params, @@ -1208,7 +1208,7 @@ def oidc_exchange_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/oidc/exchange', 'POST', path_params, @@ -1306,7 +1306,7 @@ def oidc_logout_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/oidc/logout', 'GET', path_params, @@ -1404,7 +1404,7 @@ def oidc_request_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/oidc/request', 'GET', path_params, diff --git a/nipyapi/nifi/apis/connections_api.py b/nipyapi/nifi/apis/connections_api.py index 505b0d17..bf316e07 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -141,7 +141,7 @@ def delete_connection_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/connections/{id}', 'DELETE', path_params, @@ -247,7 +247,7 @@ def get_connection_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/connections/{id}', 'GET', path_params, @@ -360,7 +360,7 @@ def update_connection_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/connections/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index 667a7269..aa0802de 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -129,7 +129,7 @@ def create_bulletin_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/bulletin', 'POST', path_params, @@ -235,7 +235,7 @@ def create_controller_service_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/controller-services', 'POST', path_params, @@ -341,7 +341,7 @@ def create_registry_client_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/registry-clients', 'POST', path_params, @@ -447,7 +447,7 @@ def create_reporting_task_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/reporting-tasks', 'POST', path_params, @@ -553,7 +553,7 @@ def delete_history_with_http_info(self, end_date, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/history', 'DELETE', path_params, @@ -659,7 +659,7 @@ def delete_node_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/cluster/nodes/{id}', 'DELETE', path_params, @@ -777,7 +777,7 @@ def delete_registry_client_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/registry-clients/{id}', 'DELETE', path_params, @@ -875,7 +875,7 @@ def get_cluster_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/cluster', 'GET', path_params, @@ -973,7 +973,7 @@ def get_controller_config_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/config', 'GET', path_params, @@ -1079,7 +1079,7 @@ def get_node_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/cluster/nodes/{id}', 'GET', path_params, @@ -1185,7 +1185,7 @@ def get_registry_client_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/registry-clients/{id}', 'GET', path_params, @@ -1283,7 +1283,7 @@ def get_registry_clients_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/registry-clients', 'GET', path_params, @@ -1389,7 +1389,7 @@ def update_controller_config_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/config', 'PUT', path_params, @@ -1502,7 +1502,7 @@ def update_node_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/cluster/nodes/{id}', 'PUT', path_params, @@ -1615,7 +1615,7 @@ def update_registry_client_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller/registry-clients/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/controller_services_api.py b/nipyapi/nifi/apis/controller_services_api.py index fc89d578..8f84033e 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -129,7 +129,7 @@ def clear_state_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}/state/clear-requests', 'POST', path_params, @@ -235,7 +235,7 @@ def get_controller_service_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}', 'GET', path_params, @@ -341,7 +341,7 @@ def get_controller_service_references_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}/references', 'GET', path_params, @@ -454,7 +454,7 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}/descriptors', 'GET', path_params, @@ -560,7 +560,7 @@ def get_state_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}/state', 'GET', path_params, @@ -678,7 +678,7 @@ def remove_controller_service_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}', 'DELETE', path_params, @@ -791,7 +791,7 @@ def update_controller_service_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}', 'PUT', path_params, @@ -904,7 +904,7 @@ def update_controller_service_references_with_http_info(self, id, body, **kwargs select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}/references', 'PUT', path_params, @@ -1017,7 +1017,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/controller-services/{id}/run-status', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/counters_api.py b/nipyapi/nifi/apis/counters_api.py index 8d64ca65..69fb156c 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -130,7 +130,7 @@ def get_counters_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/counters', 'GET', path_params, @@ -236,7 +236,7 @@ def update_counter_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/counters/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/data_transfer_api.py b/nipyapi/nifi/apis/data_transfer_api.py index 705e0335..ed44f9ff 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -143,7 +143,7 @@ def commit_input_port_transaction_with_http_info(self, response_code, port_id, t select_header_content_type(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/data-transfer/input-ports/{portId}/transactions/{transactionId}', 'DELETE', path_params, @@ -270,7 +270,7 @@ def commit_output_port_transaction_with_http_info(self, response_code, checksum, select_header_content_type(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/data-transfer/output-ports/{portId}/transactions/{transactionId}', 'DELETE', path_params, @@ -379,7 +379,7 @@ def create_port_transaction_with_http_info(self, port_type, port_id, **kwargs): select_header_accept(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/data-transfer/{portType}/{portId}/transactions', 'POST', path_params, @@ -492,7 +492,7 @@ def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_ select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/data-transfer/input-ports/{portId}/transactions/{transactionId}', 'PUT', path_params, @@ -605,7 +605,7 @@ def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/data-transfer/output-ports/{portId}/transactions/{transactionId}', 'PUT', path_params, @@ -718,7 +718,7 @@ def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): select_header_content_type(['application/octet-stream']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files', 'POST', path_params, @@ -831,7 +831,7 @@ def transfer_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files', 'GET', path_params, diff --git a/nipyapi/nifi/apis/flow_api.py b/nipyapi/nifi/apis/flow_api.py index fd30ee40..de6c99ca 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -136,7 +136,7 @@ def activate_controller_services_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/process-groups/{id}/controller-services', 'PUT', path_params, @@ -234,7 +234,7 @@ def generate_client_id_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/client-id', 'GET', path_params, @@ -332,7 +332,7 @@ def get_about_info_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/about', 'GET', path_params, @@ -438,7 +438,7 @@ def get_action_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/history/{id}', 'GET', path_params, @@ -536,7 +536,7 @@ def get_banners_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/banners', 'GET', path_params, @@ -642,7 +642,7 @@ def get_buckets_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/registries/{id}/buckets', 'GET', path_params, @@ -765,7 +765,7 @@ def get_bulletin_board_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/bulletin-board', 'GET', path_params, @@ -863,7 +863,7 @@ def get_bulletins_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/controller/bulletins', 'GET', path_params, @@ -961,7 +961,7 @@ def get_cluster_summary_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/cluster/summary', 'GET', path_params, @@ -1067,7 +1067,7 @@ def get_component_history_with_http_info(self, component_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/history/components/{componentId}', 'GET', path_params, @@ -1181,7 +1181,7 @@ def get_connection_statistics_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/connections/{id}/statistics', 'GET', path_params, @@ -1295,7 +1295,7 @@ def get_connection_status_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/connections/{id}/status', 'GET', path_params, @@ -1401,7 +1401,7 @@ def get_connection_status_history_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/connections/{id}/status/history', 'GET', path_params, @@ -1528,7 +1528,7 @@ def get_controller_service_types_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/controller-service-types', 'GET', path_params, @@ -1626,7 +1626,7 @@ def get_controller_services_from_controller_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/controller/controller-services', 'GET', path_params, @@ -1740,7 +1740,7 @@ def get_controller_services_from_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/process-groups/{id}/controller-services', 'GET', path_params, @@ -1838,7 +1838,7 @@ def get_controller_status_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/status', 'GET', path_params, @@ -1936,7 +1936,7 @@ def get_current_user_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/current-user', 'GET', path_params, @@ -2042,7 +2042,7 @@ def get_flow_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/process-groups/{id}', 'GET', path_params, @@ -2140,7 +2140,7 @@ def get_flow_config_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/config', 'GET', path_params, @@ -2253,7 +2253,7 @@ def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/registries/{registry-id}/buckets/{bucket-id}/flows', 'GET', path_params, @@ -2367,7 +2367,7 @@ def get_input_port_status_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/input-ports/{id}/status', 'GET', path_params, @@ -2481,7 +2481,7 @@ def get_output_port_status_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/output-ports/{id}/status', 'GET', path_params, @@ -2579,7 +2579,7 @@ def get_parameter_contexts_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/parameter-contexts', 'GET', path_params, @@ -2677,7 +2677,7 @@ def get_prioritizers_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/prioritizers', 'GET', path_params, @@ -2795,7 +2795,7 @@ def get_process_group_status_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/process-groups/{id}/status', 'GET', path_params, @@ -2901,7 +2901,7 @@ def get_process_group_status_history_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/process-groups/{id}/status/history', 'GET', path_params, @@ -3015,7 +3015,7 @@ def get_processor_status_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/processors/{id}/status', 'GET', path_params, @@ -3121,7 +3121,7 @@ def get_processor_status_history_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/processors/{id}/status/history', 'GET', path_params, @@ -3232,7 +3232,7 @@ def get_processor_types_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/processor-types', 'GET', path_params, @@ -3330,7 +3330,7 @@ def get_registries_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/registries', 'GET', path_params, @@ -3444,7 +3444,7 @@ def get_remote_process_group_status_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/remote-process-groups/{id}/status', 'GET', path_params, @@ -3550,7 +3550,7 @@ def get_remote_process_group_status_history_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/remote-process-groups/{id}/status/history', 'GET', path_params, @@ -3661,7 +3661,7 @@ def get_reporting_task_types_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/reporting-task-types', 'GET', path_params, @@ -3759,7 +3759,7 @@ def get_reporting_tasks_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/reporting-tasks', 'GET', path_params, @@ -3857,7 +3857,7 @@ def get_templates_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/templates', 'GET', path_params, @@ -3977,7 +3977,7 @@ def get_versions_with_http_info(self, registry_id, bucket_id, flow_id, **kwargs) select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions', 'GET', path_params, @@ -4114,7 +4114,7 @@ def query_history_with_http_info(self, offset, count, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/history', 'GET', path_params, @@ -4227,7 +4227,7 @@ def schedule_components_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/process-groups/{id}', 'PUT', path_params, @@ -4333,7 +4333,7 @@ def search_cluster_with_http_info(self, q, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/cluster/search-results', 'GET', path_params, @@ -4436,7 +4436,7 @@ def search_flow_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flow/search-results', 'GET', path_params, diff --git a/nipyapi/nifi/apis/flowfile_queues_api.py b/nipyapi/nifi/apis/flowfile_queues_api.py index 59934672..2e382535 100644 --- a/nipyapi/nifi/apis/flowfile_queues_api.py +++ b/nipyapi/nifi/apis/flowfile_queues_api.py @@ -129,7 +129,7 @@ def create_drop_request_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/drop-requests', 'POST', path_params, @@ -235,7 +235,7 @@ def create_flow_file_listing_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/listing-requests', 'POST', path_params, @@ -348,7 +348,7 @@ def delete_listing_request_with_http_info(self, id, listing_request_id, **kwargs select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/listing-requests/{listing-request-id}', 'DELETE', path_params, @@ -469,7 +469,7 @@ def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs) select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content', 'GET', path_params, @@ -582,7 +582,7 @@ def get_drop_request_with_http_info(self, id, drop_request_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/drop-requests/{drop-request-id}', 'GET', path_params, @@ -699,7 +699,7 @@ def get_flow_file_with_http_info(self, id, flowfile_uuid, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/flowfiles/{flowfile-uuid}', 'GET', path_params, @@ -812,7 +812,7 @@ def get_listing_request_with_http_info(self, id, listing_request_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/listing-requests/{listing-request-id}', 'GET', path_params, @@ -925,7 +925,7 @@ def remove_drop_request_with_http_info(self, id, drop_request_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/flowfile-queues/{id}/drop-requests/{drop-request-id}', 'DELETE', path_params, diff --git a/nipyapi/nifi/apis/funnel_api.py b/nipyapi/nifi/apis/funnel_api.py index aa95d876..07d98529 100644 --- a/nipyapi/nifi/apis/funnel_api.py +++ b/nipyapi/nifi/apis/funnel_api.py @@ -129,7 +129,7 @@ def get_funnel_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/funnels/{id}', 'GET', path_params, @@ -247,7 +247,7 @@ def remove_funnel_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/funnels/{id}', 'DELETE', path_params, @@ -360,7 +360,7 @@ def update_funnel_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/funnels/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/input_ports_api.py b/nipyapi/nifi/apis/input_ports_api.py index c534cbe7..f61a6030 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -129,7 +129,7 @@ def get_input_port_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/input-ports/{id}', 'GET', path_params, @@ -247,7 +247,7 @@ def remove_input_port_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/input-ports/{id}', 'DELETE', path_params, @@ -360,7 +360,7 @@ def update_input_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/input-ports/{id}', 'PUT', path_params, @@ -473,7 +473,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/input-ports/{id}/run-status', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/labels_api.py b/nipyapi/nifi/apis/labels_api.py index 8e9b0558..e2628cdb 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -129,7 +129,7 @@ def get_label_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/labels/{id}', 'GET', path_params, @@ -247,7 +247,7 @@ def remove_label_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/labels/{id}', 'DELETE', path_params, @@ -360,7 +360,7 @@ def update_label_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/labels/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/output_ports_api.py b/nipyapi/nifi/apis/output_ports_api.py index 6cdd7df3..02feb723 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -129,7 +129,7 @@ def get_output_port_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/output-ports/{id}', 'GET', path_params, @@ -247,7 +247,7 @@ def remove_output_port_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/output-ports/{id}', 'DELETE', path_params, @@ -360,7 +360,7 @@ def update_output_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/output-ports/{id}', 'PUT', path_params, @@ -473,7 +473,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/output-ports/{id}/run-status', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/parameter_contexts_api.py b/nipyapi/nifi/apis/parameter_contexts_api.py index 58b0173d..09f668ca 100644 --- a/nipyapi/nifi/apis/parameter_contexts_api.py +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -129,7 +129,7 @@ def create_parameter_context_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts', 'POST', path_params, @@ -247,7 +247,7 @@ def delete_parameter_context_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{id}', 'DELETE', path_params, @@ -364,7 +364,7 @@ def delete_update_request_with_http_info(self, context_id, request_id, **kwargs) select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'DELETE', path_params, @@ -481,7 +481,7 @@ def delete_validation_request_with_http_info(self, context_id, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'DELETE', path_params, @@ -587,7 +587,7 @@ def get_parameter_context_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{id}', 'GET', path_params, @@ -700,7 +700,7 @@ def get_parameter_context_update_with_http_info(self, context_id, request_id, ** select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests/{requestId}', 'GET', path_params, @@ -813,7 +813,7 @@ def get_validation_request_with_http_info(self, context_id, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests/{id}', 'GET', path_params, @@ -926,7 +926,7 @@ def submit_parameter_context_update_with_http_info(self, context_id, body, **kwa select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/update-requests', 'POST', path_params, @@ -1039,7 +1039,7 @@ def submit_validation_request_with_http_info(self, context_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{contextId}/validation-requests', 'POST', path_params, @@ -1152,7 +1152,7 @@ def update_parameter_context_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/parameter-contexts/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/policies_api.py b/nipyapi/nifi/apis/policies_api.py index 8af37d4e..ca22ca37 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -129,7 +129,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/policies', 'POST', path_params, @@ -235,7 +235,7 @@ def get_access_policy_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/policies/{id}', 'GET', path_params, @@ -350,7 +350,7 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/policies/{action}/{resource}', 'GET', path_params, @@ -468,7 +468,7 @@ def remove_access_policy_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/policies/{id}', 'DELETE', path_params, @@ -581,7 +581,7 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/policies/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/process_groups_api.py b/nipyapi/nifi/apis/process_groups_api.py index 1312638d..6d244748 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -136,7 +136,7 @@ def copy_snippet_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/snippet-instance', 'POST', path_params, @@ -249,7 +249,7 @@ def create_connection_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/connections', 'POST', path_params, @@ -362,7 +362,7 @@ def create_controller_service_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/controller-services', 'POST', path_params, @@ -475,7 +475,7 @@ def create_funnel_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/funnels', 'POST', path_params, @@ -588,7 +588,7 @@ def create_input_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/input-ports', 'POST', path_params, @@ -701,7 +701,7 @@ def create_label_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/labels', 'POST', path_params, @@ -814,7 +814,7 @@ def create_output_port_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/output-ports', 'POST', path_params, @@ -927,7 +927,7 @@ def create_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/process-groups', 'POST', path_params, @@ -1040,7 +1040,7 @@ def create_processor_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/processors', 'POST', path_params, @@ -1153,7 +1153,7 @@ def create_remote_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/remote-process-groups', 'POST', path_params, @@ -1266,7 +1266,7 @@ def create_template_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/templates', 'POST', path_params, @@ -1383,7 +1383,7 @@ def delete_variable_registry_update_request_with_http_info(self, group_id, updat select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{groupId}/variable-registry/update-requests/{updateId}', 'DELETE', path_params, @@ -1489,7 +1489,7 @@ def export_process_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/download', 'GET', path_params, @@ -1595,7 +1595,7 @@ def get_connections_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/connections', 'GET', path_params, @@ -1701,7 +1701,7 @@ def get_funnels_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/funnels', 'GET', path_params, @@ -1807,7 +1807,7 @@ def get_input_ports_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/input-ports', 'GET', path_params, @@ -1913,7 +1913,7 @@ def get_labels_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/labels', 'GET', path_params, @@ -2019,7 +2019,7 @@ def get_local_modifications_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/local-modifications', 'GET', path_params, @@ -2125,7 +2125,7 @@ def get_output_ports_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/output-ports', 'GET', path_params, @@ -2231,7 +2231,7 @@ def get_process_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}', 'GET', path_params, @@ -2337,7 +2337,7 @@ def get_process_groups_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/process-groups', 'GET', path_params, @@ -2447,7 +2447,7 @@ def get_processors_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/processors', 'GET', path_params, @@ -2553,7 +2553,7 @@ def get_remote_process_groups_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/remote-process-groups', 'GET', path_params, @@ -2663,7 +2663,7 @@ def get_variable_registry_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/variable-registry', 'GET', path_params, @@ -2776,7 +2776,7 @@ def get_variable_registry_update_request_with_http_info(self, group_id, update_i select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{groupId}/variable-registry/update-requests/{updateId}', 'GET', path_params, @@ -2882,7 +2882,7 @@ def import_template_with_http_info(self, id, **kwargs): select_header_content_type(['application/xml']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/templates/import', 'POST', path_params, @@ -2995,7 +2995,7 @@ def instantiate_template_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/template-instance', 'POST', path_params, @@ -3113,7 +3113,7 @@ def remove_process_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}', 'DELETE', path_params, @@ -3226,7 +3226,7 @@ def submit_update_variable_registry_request_with_http_info(self, id, body, **kwa select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/variable-registry/update-requests', 'POST', path_params, @@ -3339,7 +3339,7 @@ def update_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}', 'PUT', path_params, @@ -3452,7 +3452,7 @@ def update_variable_registry_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/variable-registry', 'PUT', path_params, @@ -3569,7 +3569,7 @@ def upload_template_with_http_info(self, id, template, **kwargs): select_header_content_type(['multipart/form-data']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/process-groups/{id}/templates/upload', 'POST', path_params, diff --git a/nipyapi/nifi/apis/processors_api.py b/nipyapi/nifi/apis/processors_api.py index b43c15f6..23151ae7 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -129,7 +129,7 @@ def clear_state_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}/state/clear-requests', 'POST', path_params, @@ -247,7 +247,7 @@ def delete_processor_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}', 'DELETE', path_params, @@ -353,7 +353,7 @@ def get_processor_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}', 'GET', path_params, @@ -459,7 +459,7 @@ def get_processor_diagnostics_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}/diagnostics', 'GET', path_params, @@ -576,7 +576,7 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}/descriptors', 'GET', path_params, @@ -682,7 +682,7 @@ def get_state_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}/state', 'GET', path_params, @@ -788,7 +788,7 @@ def terminate_processor_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}/threads', 'DELETE', path_params, @@ -901,7 +901,7 @@ def update_processor_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}', 'PUT', path_params, @@ -1014,7 +1014,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/processors/{id}/run-status', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index c8903dab..b78219e3 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -133,7 +133,7 @@ def delete_lineage_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance/lineage/{id}', 'DELETE', path_params, @@ -243,7 +243,7 @@ def delete_provenance_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance/{id}', 'DELETE', path_params, @@ -353,7 +353,7 @@ def get_lineage_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance/lineage/{id}', 'GET', path_params, @@ -471,7 +471,7 @@ def get_provenance_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance/{id}', 'GET', path_params, @@ -569,7 +569,7 @@ def get_search_options_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance/search-options', 'GET', path_params, @@ -675,7 +675,7 @@ def submit_lineage_request_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance/lineage', 'POST', path_params, @@ -781,7 +781,7 @@ def submit_provenance_request_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance', 'POST', path_params, diff --git a/nipyapi/nifi/apis/provenance_events_api.py b/nipyapi/nifi/apis/provenance_events_api.py index 77a1457a..836fe8ce 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -133,7 +133,7 @@ def get_input_content_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance-events/{id}/content/input', 'GET', path_params, @@ -243,7 +243,7 @@ def get_output_content_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance-events/{id}/content/output', 'GET', path_params, @@ -353,7 +353,7 @@ def get_provenance_event_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance-events/{id}', 'GET', path_params, @@ -459,7 +459,7 @@ def submit_replay_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/provenance-events/replays', 'POST', path_params, diff --git a/nipyapi/nifi/apis/remote_process_groups_api.py b/nipyapi/nifi/apis/remote_process_groups_api.py index 8389ecab..c516db4d 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -129,7 +129,7 @@ def get_remote_process_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}', 'GET', path_params, @@ -235,7 +235,7 @@ def get_state_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}/state', 'GET', path_params, @@ -353,7 +353,7 @@ def remove_remote_process_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}', 'DELETE', path_params, @@ -466,7 +466,7 @@ def update_remote_process_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}', 'PUT', path_params, @@ -586,7 +586,7 @@ def update_remote_process_group_input_port_with_http_info(self, id, port_id, bod select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}/input-ports/{port-id}', 'PUT', path_params, @@ -706,7 +706,7 @@ def update_remote_process_group_input_port_run_status_with_http_info(self, id, p select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}/input-ports/{port-id}/run-status', 'PUT', path_params, @@ -826,7 +826,7 @@ def update_remote_process_group_output_port_with_http_info(self, id, port_id, bo select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}/output-ports/{port-id}', 'PUT', path_params, @@ -946,7 +946,7 @@ def update_remote_process_group_output_port_run_status_with_http_info(self, id, select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}/output-ports/{port-id}/run-status', 'PUT', path_params, @@ -1059,7 +1059,7 @@ def update_remote_process_group_run_status_with_http_info(self, id, body, **kwar select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/remote-process-groups/{id}/run-status', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/reporting_tasks_api.py b/nipyapi/nifi/apis/reporting_tasks_api.py index ef4521b9..6e18acc5 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -129,7 +129,7 @@ def clear_state_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/reporting-tasks/{id}/state/clear-requests', 'POST', path_params, @@ -242,7 +242,7 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/reporting-tasks/{id}/descriptors', 'GET', path_params, @@ -348,7 +348,7 @@ def get_reporting_task_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/reporting-tasks/{id}', 'GET', path_params, @@ -454,7 +454,7 @@ def get_state_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/reporting-tasks/{id}/state', 'GET', path_params, @@ -572,7 +572,7 @@ def remove_reporting_task_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/reporting-tasks/{id}', 'DELETE', path_params, @@ -685,7 +685,7 @@ def update_reporting_task_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/reporting-tasks/{id}', 'PUT', path_params, @@ -798,7 +798,7 @@ def update_run_status_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/reporting-tasks/{id}/run-status', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/resources_api.py b/nipyapi/nifi/apis/resources_api.py index af7d122c..8c52dd59 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -121,7 +121,7 @@ def get_resources_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/resources', 'GET', path_params, diff --git a/nipyapi/nifi/apis/site_to_site_api.py b/nipyapi/nifi/apis/site_to_site_api.py index c40da03a..564c21da 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -121,7 +121,7 @@ def get_peers_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/site-to-site/peers', 'GET', path_params, @@ -219,7 +219,7 @@ def get_site_to_site_details_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/site-to-site', 'GET', path_params, diff --git a/nipyapi/nifi/apis/snippets_api.py b/nipyapi/nifi/apis/snippets_api.py index d48a1985..003dc3e1 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -129,7 +129,7 @@ def create_snippet_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/snippets', 'POST', path_params, @@ -239,7 +239,7 @@ def delete_snippet_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/snippets/{id}', 'DELETE', path_params, @@ -352,7 +352,7 @@ def update_snippet_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/snippets/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/system_diagnostics_api.py b/nipyapi/nifi/apis/system_diagnostics_api.py index 7e23a857..1b4ffc17 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -130,7 +130,7 @@ def get_system_diagnostics_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/system-diagnostics', 'GET', path_params, diff --git a/nipyapi/nifi/apis/templates_api.py b/nipyapi/nifi/apis/templates_api.py index 76b6adc8..637ac4dc 100644 --- a/nipyapi/nifi/apis/templates_api.py +++ b/nipyapi/nifi/apis/templates_api.py @@ -129,7 +129,7 @@ def export_template_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/templates/{id}/download', 'GET', path_params, @@ -239,7 +239,7 @@ def remove_template_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/templates/{id}', 'DELETE', path_params, diff --git a/nipyapi/nifi/apis/tenants_api.py b/nipyapi/nifi/apis/tenants_api.py index 353cfa2a..9d52f8b1 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -129,7 +129,7 @@ def create_user_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/users', 'POST', path_params, @@ -235,7 +235,7 @@ def create_user_group_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/user-groups', 'POST', path_params, @@ -341,7 +341,7 @@ def get_user_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/users/{id}', 'GET', path_params, @@ -447,7 +447,7 @@ def get_user_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'GET', path_params, @@ -545,7 +545,7 @@ def get_user_groups_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/user-groups', 'GET', path_params, @@ -643,7 +643,7 @@ def get_users_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/users', 'GET', path_params, @@ -761,7 +761,7 @@ def remove_user_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/users/{id}', 'DELETE', path_params, @@ -879,7 +879,7 @@ def remove_user_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'DELETE', path_params, @@ -985,7 +985,7 @@ def search_tenants_with_http_info(self, q, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/search-results', 'GET', path_params, @@ -1098,7 +1098,7 @@ def update_user_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/users/{id}', 'PUT', path_params, @@ -1211,7 +1211,7 @@ def update_user_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/tenants/user-groups/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/apis/versions_api.py b/nipyapi/nifi/apis/versions_api.py index 050c2cb9..e74a76c6 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -129,7 +129,7 @@ def create_version_control_request_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/active-requests', 'POST', path_params, @@ -239,7 +239,7 @@ def delete_revert_request_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/revert-requests/{id}', 'DELETE', path_params, @@ -349,7 +349,7 @@ def delete_update_request_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/update-requests/{id}', 'DELETE', path_params, @@ -459,7 +459,7 @@ def delete_version_control_request_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/active-requests/{id}', 'DELETE', path_params, @@ -565,7 +565,7 @@ def export_flow_version_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/process-groups/{id}/download', 'GET', path_params, @@ -671,7 +671,7 @@ def get_revert_request_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/revert-requests/{id}', 'GET', path_params, @@ -777,7 +777,7 @@ def get_update_request_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/update-requests/{id}', 'GET', path_params, @@ -883,7 +883,7 @@ def get_version_information_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'GET', path_params, @@ -996,7 +996,7 @@ def initiate_revert_flow_version_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/revert-requests/process-groups/{id}', 'POST', path_params, @@ -1109,7 +1109,7 @@ def initiate_version_control_update_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/update-requests/process-groups/{id}', 'POST', path_params, @@ -1222,7 +1222,7 @@ def save_to_flow_registry_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'POST', path_params, @@ -1340,7 +1340,7 @@ def stop_version_control_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'DELETE', path_params, @@ -1453,7 +1453,7 @@ def update_flow_version_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/process-groups/{id}', 'PUT', path_params, @@ -1566,7 +1566,7 @@ def update_version_control_request_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/versions/active-requests/{id}', 'PUT', path_params, diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 48eed0c7..51ab46cd 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -52,6 +52,8 @@ def __init__(self): self.temp_folder_path = None # Authentication Settings + # Auth types to enable, use tokenAuth or basicAuth + self.enabled_auth = ['tokenAuth'] # dict to store API key(s) self.api_key = {} # dict to store API prefix (e.g. Bearer) @@ -188,10 +190,12 @@ def get_api_key_with_prefix(self, identifier): :param identifier: The identifier of apiKey. :return: The token for api key authentication. """ - if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): - return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] - elif self.api_key.get(identifier): - return self.api_key[identifier] + if identifier in self.enabled_auth: + if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): + return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] + elif self.api_key.get(identifier): + return self.api_key[identifier] + return None def get_basic_auth_token(self): """ @@ -199,8 +203,10 @@ def get_basic_auth_token(self): :return: The token for basic HTTP authentication. """ - return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ - .get('authorization') + if 'basicAuth' in self.enabled_auth: + return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ + .get('authorization') + return None def auth_settings(self): """ @@ -216,6 +222,13 @@ def auth_settings(self): 'key': 'Authorization', 'value': self.get_api_key_with_prefix('tokenAuth') }, + 'basicAuth': + { + 'type': 'basic', + 'in': 'header', + 'key': 'Authorization', + 'value': self.get_basic_auth_token() + }, } diff --git a/nipyapi/security.py b/nipyapi/security.py index a4f15e98..ceaef7e5 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -264,7 +264,7 @@ def remove_service_user_group(group, service='nifi', strict=True): def service_login(service='nifi', username=None, password=None, - bool_response=False): + bool_response=False, auth_type='token'): """ Login to the currently configured NiFi or NiFi-Registry server. @@ -286,6 +286,7 @@ def service_login(service='nifi', username=None, password=None, password (str): The password to use bool_response (bool): If True, the function will return False instead of an error. Useful for connection testing. + auth_type (str): token (default) or basic Returns: (bool): True if successful, False or an Error if not. See bool_response @@ -314,20 +315,23 @@ def service_login(service='nifi', username=None, password=None, # Registry pulls from config, NiFi allows submission configuration.username = uname configuration.password = pword - log.info("Attempting login with user identity [%s]", - configuration.username) - try: - if service == 'nifi': - token = nipyapi.nifi.AccessApi().create_access_token( - username=uname, password=pword) - else: - token = nipyapi.registry.AccessApi() \ - .create_access_token_using_basic_auth_credentials() - except getattr(nipyapi, service).rest.ApiException as e: - if bool_response: - return False - raise ValueError(e.body) - set_service_auth_token(token=token, service=service) + if auth_type == 'token': + log.info("Attempting tokenAuth login with user identity [%s]", + configuration.username) + try: + if service == 'nifi': + token = nipyapi.nifi.AccessApi().create_access_token( + username=uname, password=pword) + else: + token = nipyapi.registry.AccessApi() \ + .create_access_token_using_basic_auth_credentials() + except getattr(nipyapi, service).rest.ApiException as e: + if bool_response: + return False + raise ValueError(e.body) + set_service_auth_token(token=token, service=service) + elif auth_type == 'basic': + log.info("basicAuth set, skipping token retrieval") return True @@ -375,7 +379,14 @@ def service_logout(service='nifi'): """ assert service in _valid_services set_service_auth_token(token=None, service=service) - status = get_service_access_status(service, bool_response=True) + try: + status = get_service_access_status(service, bool_response=True) + except ValueError as e: + if 'Cannot set verify_mode to CERT_NONE' in str(e): + status = None + # Logout throws error with incorrect ssl setup + else: + raise e # Set to empty string and not None as basic auth setup will still # run even if not used getattr(nipyapi, service).configuration.password = '' diff --git a/nipyapi/templates.py b/nipyapi/templates.py index 16d5cf2c..f6ae3b74 100644 --- a/nipyapi/templates.py +++ b/nipyapi/templates.py @@ -68,7 +68,7 @@ def get_template(identifier, identifier_type='name', greedy=False): if obj: return nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy) - return obj + return None def deploy_template(pg_id, template_id, loc_x=0, loc_y=0): diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 5a2d731f..c5c2c3cb 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -256,12 +256,16 @@ def is_endpoint_up(endpoint_url): """ log.info("Called is_endpoint_up with args %s", locals()) try: - response = requests.get(endpoint_url) - if response.status_code == 200: - log.info("Got 200 response from endpoint, returning True") - return True - log.info("Got status code %s from endpoint, returning False", - response.status_code) + response = requests.get( + endpoint_url, + timeout=nipyapi.config.short_max_wait + ) + if response.status_code: + if response.status_code == 200: + log.info("Got 200 response from endpoint, returning True") + return True + log.info("Got status code %s from endpoint, returning False", + response.status_code) return False except (requests.ConnectionError, requests.exceptions.SSLError) as e: log.info("Got Error of type %s with details %s", type(e), str(e)) @@ -304,7 +308,8 @@ def set_endpoint(endpoint_url, ssl=False, login=False): nipyapi.security.service_logout(service) # Resetting API client so it recreates from config.host configuration.api_client = None - configuration.host = endpoint_url + # remove any trailing slash to avoid hard to spot errors + configuration.host = endpoint_url.rstrip('/') if 'https://' in endpoint_url and ssl: if not login: nipyapi.security.set_service_ssl_context( diff --git a/resources/client_gen/swagger_templates/api.mustache b/resources/client_gen/swagger_templates/api.mustache index 503df4a3..ab2d9087 100644 --- a/resources/client_gen/swagger_templates/api.mustache +++ b/resources/client_gen/swagger_templates/api.mustache @@ -208,7 +208,7 @@ class {{classname}}(object): {{/hasConsumes}} # Authentication setting - auth_settings = ['tokenAuth'{{#authMethods}}, '{{name}}'{{/authMethods}}] + auth_settings = ['tokenAuth', 'basicAuth'{{#authMethods}}, '{{name}}'{{/authMethods}}] return self.api_client.call_api('{{{path}}}', '{{httpMethod}}', path_params, diff --git a/resources/client_gen/swagger_templates/configuration.mustache b/resources/client_gen/swagger_templates/configuration.mustache index 06314186..dd9f4536 100644 --- a/resources/client_gen/swagger_templates/configuration.mustache +++ b/resources/client_gen/swagger_templates/configuration.mustache @@ -43,6 +43,8 @@ class Configuration(object): self.temp_folder_path = None # Authentication Settings + # Auth types to enable + self.enabled_auth = ['tokenAuth', 'basicAuth'] # dict to store API key(s) self.api_key = {} # dict to store API prefix (e.g. Bearer) @@ -182,10 +184,12 @@ class Configuration(object): :param identifier: The identifier of apiKey. :return: The token for api key authentication. """ - if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): - return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] - elif self.api_key.get(identifier): - return self.api_key[identifier] + if identifier in self.enabled_auth: + if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): + return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] + elif self.api_key.get(identifier): + return self.api_key[identifier] + return None def get_basic_auth_token(self): """ @@ -193,8 +197,10 @@ class Configuration(object): :return: The token for basic HTTP authentication. """ - return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ - .get('authorization') + if 'basicAuth' in self.enabled_auth: + return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ + .get('authorization') + return None def auth_settings(self): """ @@ -210,6 +216,13 @@ class Configuration(object): 'key': 'Authorization', 'value': self.get_api_key_with_prefix('tokenAuth') }, + 'basicAuth': + { + 'type': 'basic', + 'in': 'header', + 'key': 'Authorization', + 'value': self.get_basic_auth_token() + }, {{#authMethods}} {{#isApiKey}} '{{name}}': diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index 82d9cc30..ffd443ee 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,7 +2,7 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.11.3 + image: apache/nifi:1.11.4 container_name: nifi hostname: nifi ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index 86d232a1..f6bcc941 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.1' services: secure-nifi: - image: apache/nifi:1.11.3 + image: apache/nifi:1.11.4 container_name: secure-nifi hostname: secure-nifi ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index eda55f05..89650ae3 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -25,7 +25,7 @@ services: ports: - "10192:8080" nifi: - image: apache/nifi:1.11.3 + image: apache/nifi:1.11.4 container_name: nifi hostname: nifi ports: diff --git a/setup.cfg b/setup.cfg index 4e3be951..d07329a5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.14.1 +current_version = 0.14.3 commit = True tag = True diff --git a/setup.py b/setup.py index ff621c83..309ebd90 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ with open('docs/history.rst') as history_file: history = history_file.read() -proj_version = '0.14.1' +proj_version = '0.14.3' with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() diff --git a/tests/conftest.py b/tests/conftest.py index 76da6856..326f9ba9 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -187,6 +187,7 @@ def regress_flow_reg(request): def session_setup(request): log.info("Commencing test session setup") for url in nifi_test_endpoints + [x[0] for x in registry_test_endpoints]: + log.debug("Now Checking URL [{0}]".format(url)) nipyapi.utils.set_endpoint(url, ssl=True, login=True) # ssl and login will only work if https is in the url, else will silently skip gui_url = url.replace('-api', '') From de7bb475fd266ae76b86b75037b40e2710dcb90e Mon Sep 17 00:00:00 2001 From: Raz Date: Fri, 26 Jun 2020 11:58:22 +0300 Subject: [PATCH 30/40] Fix create empty group (#207) * Fixed: Can create a group without pass users list * Fixed: Can create a group without pass users list #1 --- nipyapi/security.py | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/nipyapi/security.py b/nipyapi/security.py index ceaef7e5..4d189d1e 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -155,26 +155,30 @@ def create_service_user_group(identity, service='nifi', """ assert service in _valid_services assert isinstance(identity, six.string_types) + + users_ids = None + if service == 'nifi': - assert all(isinstance(user, nipyapi.nifi.UserEntity) for user in users) - else: - assert all(isinstance(user, nipyapi.registry.User) for user in users) - if service == 'registry': - user_group_obj = nipyapi.registry.UserGroup( - identity=identity, - users=[{'identifier': user.identifier} for user in users] - ) - else: - # must be nifi + if users: + assert all(isinstance(user, nipyapi.nifi.UserEntity) for user in users) + users_ids = [{'id': user.id} for user in users] user_group_obj = nipyapi.nifi.UserGroupEntity( revision=nipyapi.nifi.RevisionDTO( version=0 ), component=nipyapi.nifi.UserGroupDTO( identity=identity, - users=[{'id': user.id} for user in users] + users=users_ids ) ) + else: + if users: + assert all(isinstance(user, nipyapi.registry.User) for user in users) + users_ids = [{'identifier': user.identifier} for user in users] + user_group_obj = nipyapi.registry.UserGroup( + identity=identity, + users=users_ids + ) try: return getattr(nipyapi, service).TenantsApi().create_user_group( user_group_obj From f9e2c247c541cbcefa331e18c4fb0fba4fab3454 Mon Sep 17 00:00:00 2001 From: Bernhard Geisberger <41961259+bgeisberger@users.noreply.github.com> Date: Fri, 26 Jun 2020 11:05:15 +0200 Subject: [PATCH 31/40] Allow deploy_template to use floats for positions (#191) --- nipyapi/templates.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nipyapi/templates.py b/nipyapi/templates.py index f6ae3b74..e949e25b 100644 --- a/nipyapi/templates.py +++ b/nipyapi/templates.py @@ -71,7 +71,7 @@ def get_template(identifier, identifier_type='name', greedy=False): return None -def deploy_template(pg_id, template_id, loc_x=0, loc_y=0): +def deploy_template(pg_id, template_id, loc_x=0.0, loc_y=0.0): """ Instantiates a given template request in a given process group @@ -80,8 +80,8 @@ def deploy_template(pg_id, template_id, loc_x=0, loc_y=0): 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 (int): The X coordinate to deploy the Template at. Default(0) - loc_y (int): The X coordinate to deploy the Template at. Default(0) + 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: (FlowEntity): The FlowEntity of the Process Group with the deployed From 735d0e24a35df90322eb6083c9ea043df6a84727 Mon Sep 17 00:00:00 2001 From: Raz Date: Fri, 26 Jun 2020 12:13:48 +0300 Subject: [PATCH 32/40] Fix searching by unique identifier (#205) * Fix the search according unique identifier * Fix the search according unique identifier and update functions doc * Minor typo correction Co-authored-by: Dan Chaffelson --- nipyapi/security.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/nipyapi/security.py b/nipyapi/security.py index 4d189d1e..9ecdc8ad 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -44,7 +44,7 @@ def list_service_users(service='nifi'): def get_service_user(identifier, identifier_type='identity', service='nifi'): """ - Filters the all users list for a given identifier and type + Gets the unique user matching to the given identifier and type. Args: identifier (str): the string to search for @@ -52,14 +52,14 @@ def get_service_user(identifier, identifier_type='identity', service='nifi'): service (str): the name of the service Returns: - None if no match, list of multiple matches, else single object + None if no match, else single object """ assert service in _valid_services assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_users(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) return out @@ -212,7 +212,7 @@ def list_service_user_groups(service='nifi'): def get_service_user_group(identifier, identifier_type='identity', service='nifi'): """ - Filters the all groups list for a given identifier and type + Gets the unique group matching to the given identifier and type. Args: identifier (str): the string to search for @@ -220,14 +220,14 @@ def get_service_user_group(identifier, identifier_type='identity', service (str): the name of the service Returns: - None if no match, list of multiple matches, else single object + None if no match, else single object """ assert service in _valid_services assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_user_groups(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) return out From 31d4f1036a780cd04f53e8653c87bc1cecff5238 Mon Sep 17 00:00:00 2001 From: Eric Secules Date: Fri, 26 Jun 2020 02:16:50 -0700 Subject: [PATCH 33/40] Added Parameter Contexts API to docs (#196) * Added Parameter Contexts API to docs * omit docs from coverage stats. --- docs/nipyapi-docs/nipyapi.nifi.apis.rst | 8 ++++++++ tox.ini | 5 +++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/nipyapi-docs/nipyapi.nifi.apis.rst b/docs/nipyapi-docs/nipyapi.nifi.apis.rst index 4c3fa8e5..9b5a1a5d 100644 --- a/docs/nipyapi-docs/nipyapi.nifi.apis.rst +++ b/docs/nipyapi-docs/nipyapi.nifi.apis.rst @@ -100,6 +100,14 @@ nipyapi.nifi.apis.output\_ports\_api module :undoc-members: :show-inheritance: +nipyapi.nifi.apis.parameter\_contexts\_api module +-------------------------------------- + +.. automodule:: nipyapi.nifi.apis.parameter_contexts_api + :members: + :undoc-members: + :show-inheritance: + nipyapi.nifi.apis.policies\_api module -------------------------------------- diff --git a/tox.ini b/tox.ini index 0d5e9eb9..d05f2ade 100644 --- a/tox.ini +++ b/tox.ini @@ -29,11 +29,12 @@ include = # Include the NiPyApi code nipyapi/* omit = - # Do not include procedurally generated swagger clients or demos + # Do not include procedurally generated swagger clients, docs or demos nipyapi/nifi/* nipyapi/registry/* nipyapi/demo/* - + nipyapi/docs/* + [testenv] setenv = PYTHONPATH = {toxinidir} From 164351ee2d92f8c4a75989310662bbad0f7bafc4 Mon Sep 17 00:00:00 2001 From: Otto Fowler Date: Fri, 26 Jun 2020 05:18:09 -0400 Subject: [PATCH 34/40] keep track of the docker container object, and use it to kill the container when we are done (#203) set auto remove to true --- nipyapi/demo/secure_connection.py | 5 +++++ nipyapi/utils.py | 17 +++++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/nipyapi/demo/secure_connection.py b/nipyapi/demo/secure_connection.py index 9288e1ec..787d0bd8 100644 --- a/nipyapi/demo/secure_connection.py +++ b/nipyapi/demo/secure_connection.py @@ -248,4 +248,9 @@ def bootstrap_nifi_access_policies(user='nobel'): except ValueError: reg_client_0 = nipyapi.versioning.get_registry_client(_rc0) +log.info("killing the running containers") + +for docker_container in d_containers: + docker_container.get_container().kill() + pprint("All Done!") diff --git a/nipyapi/utils.py b/nipyapi/utils.py index c5c2c3cb..384cae35 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -340,6 +340,7 @@ def __init__(self, name=None, image_name=None, image_tag=None, ports=None, self.volumes = volumes self.test_url = test_url self.endpoint = endpoint + self.container = None def get_test_url_status(self): """ @@ -351,6 +352,14 @@ def get_test_url_status(self): except requests.ConnectionError: return 'ConnectionError' + def set_container(self, container): + self.container = container + + + def get_container(self): + return self.container + + def start_docker_containers(docker_containers, network_name='demo'): """ @@ -414,10 +423,9 @@ def start_docker_containers(docker_containers, network_name='demo'): # Deploy Containers log.info("Starting relevant Docker Containers") - c_hooks = {} for c in docker_containers: log.info("Starting Container %s", c.name) - c_hooks[c.name] = d_client.containers.run( + c.set_container(d_client.containers.run( image=c.image_name + ':' + c.image_tag, detach=True, network=network_name, @@ -425,8 +433,9 @@ def start_docker_containers(docker_containers, network_name='demo'): name=c.name, ports=c.ports, environment=c.env, - volumes=c.volumes - ) + volumes=c.volumes, + auto_remove=True + )) def check_version(base, comparator=None, service='nifi'): From f54f2044d1d812ebf228ae0cc718c18ad4c9efb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Vial?= Date: Sun, 1 Nov 2020 23:46:31 +0100 Subject: [PATCH 35/40] fixed funnel position (#224) * fixed funnel position, added test and contribution markdown * removed duplicate file --- nipyapi/canvas.py | 10 +++++----- tests/test_canvas.py | 2 ++ 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 43964708..1f83998f 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -1536,13 +1536,13 @@ def create_funnel(pg_id, position=None): return nipyapi.nifi.ProcessGroupsApi().create_funnel( id=pg_id, body=nipyapi.nifi.FunnelEntity( - position=nipyapi.nifi.PositionDTO( - x=float(position[0]), - y=float(position[1]) - ), revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.FunnelDTO( - parent_group_id=pg_id + parent_group_id=pg_id, + position=nipyapi.nifi.PositionDTO( + x=float(position[0]), + y=float(position[1]) + ), ) ) ) diff --git a/tests/test_canvas.py b/tests/test_canvas.py index 66c33125..41e7b358 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -657,6 +657,8 @@ def test_connect_output_ports(regress_nifi, fix_pg): def test_create_funnel(regress_nifi, fix_funnel): f_f1 = fix_funnel.generate() assert isinstance(f_f1, nifi.FunnelEntity) + assert f_f1.component.position.x == 400 + assert f_f1.component.position.y == 400 def test_delete_funnel(regress_nifi, fix_funnel): From c655aaefc1c77801e37583e9b9a1117e8152a442 Mon Sep 17 00:00:00 2001 From: Otto Fowler Date: Thu, 5 Nov 2020 10:28:22 -0500 Subject: [PATCH 36/40] =?UTF-8?q?add=20functions=20for=20working=20reading?= =?UTF-8?q?=20template.xml=20files=20into=20TemplateEnt=E2=80=A6=20(#223)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add functions for working reading template.xml files into TemplateEntity instances * undo formatting * fix import * fix test assertion and type --- README.rst | 2 +- docs/contributing.rst | 10 ++++++- nipyapi/templates.py | 64 ++++++++++++++++++++++++++++++++++++++++- requirements.txt | 3 ++ tests/test_templates.py | 46 +++++++++++++++++++++++++++++ 5 files changed, 122 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 49d8f458..2f127e24 100644 --- a/README.rst +++ b/README.rst @@ -105,4 +105,4 @@ Python Requirements | Python 2.7 or 3.5-7 supported, though other versions may work. *We will shortly stop supporting Python2* | 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 and ruamel.yaml in processing, and Docker for demo/tests. +| Outside of the standard Python modules, we make use of lxml, DeepDiff, ruamel.yaml and xmltodict in processing, and Docker for demo/tests. diff --git a/docs/contributing.rst b/docs/contributing.rst index 3ff83ed5..4fc845b4 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -79,7 +79,15 @@ Ready to contribute? Here's how to set up `nipyapi` for local development. 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 ./test_env_config/docker_compose_full_test + - 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:: diff --git a/nipyapi/templates.py b/nipyapi/templates.py index e949e25b..e408ccb3 100644 --- a/nipyapi/templates.py +++ b/nipyapi/templates.py @@ -5,10 +5,13 @@ """ from __future__ import absolute_import + +import json from os import access, R_OK, W_OK from os.path import isfile, dirname import logging import six +import xmltodict from lxml import etree import nipyapi @@ -17,7 +20,9 @@ __all__ = [ "list_all_templates", "get_template_by_name", "deploy_template", "upload_template", "create_pg_snippet", "create_template", - "delete_template", "export_template", 'get_template' + "delete_template", "export_template", 'get_template', + "load_template_from_xml_file_path", "load_template_from_xml_file_stream", + "load_template_from_xml_string" ] @@ -262,3 +267,60 @@ def list_all_templates(native=True): return templates.templates return None return templates + + +def load_template_from_xml_file_path(file_path): + """ + Loads a TemplateEntity from an xml file for a + given path + + + Args: + file_path (str): path to the xml file + + Returns: + TemplateEntity + """ + assert isfile(file_path) and access(file_path, R_OK), \ + SystemError("File {0} invalid or unreadable".format(file_path)) + with open(file_path, "r") as template_file: + return load_template_from_xml_file_stream(template_file) + + +def load_template_from_xml_file_stream(file_stream): + """ + Loads a TemplateEntity from a template xml file + + Args: + file_stream (io stream): the xml file stream as returned by open + + Returns: + TemplateEntity + """ + return load_template_from_xml_string(file_stream.read()) + + +def load_template_from_xml_string(xml_string): + """ + Loads a TemplateEntity from xml string, as if + you had read in the xml file to string + + Args: + xml_string (str): string of xml + + Returns: + TemplateEntity + """ + assert isinstance(xml_string, six.string_types) + + json_string = json.dumps(xmltodict.parse(xml_string)) + unset = False + if nipyapi.config.nifi_config.api_client is None: + unset = True + nipyapi.config.nifi_config.api_client = nipyapi.nifi.ApiClient() + + template_entity = nipyapi.utils.load(json_string, + ('nifi', 'TemplateEntity')) + if unset: + nipyapi.config.nifi_config.api_client = None + return template_entity diff --git a/requirements.txt b/requirements.txt index 574e6d9f..2c27a10f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -19,3 +19,6 @@ ruamel.yaml==0.16.10 # Demo deployment automation docker>=2.5.1 + +# xml to json parsing +xmltodict>=0.12.0 diff --git a/tests/test_templates.py b/tests/test_templates.py index 3100e228..44cf4652 100644 --- a/tests/test_templates.py +++ b/tests/test_templates.py @@ -171,3 +171,49 @@ def test_delete_template(regress_nifi, fix_templates): assert isinstance(r, nipyapi.nifi.TemplateEntity) with pytest.raises(ValueError): _ = nipyapi.templates.delete_template('invalid') + + +def test_load_template_from_file_path(fix_templates): + template_entity = nipyapi.templates.load_template_from_xml_file_path(fix_templates.c_file) + assert isinstance(template_entity, nipyapi.nifi.TemplateEntity) + # we should be able to DeepDiff these + # but the template _from_ NIFI does not have the inner + # snipit + # pg = fix_templates.pg.generate() + # _ = nipyapi.templates.upload_template( + # pg.id, + # fix_templates.c_file + # ) + # nifi_template = nipyapi.templates.get_template(fix_templates.c_name) + # assert nifi_template is not None + # assert isinstance(nifi_template, nipyapi.nifi.TemplateEntity) + # from deepdiff import DeepDiff + # diff_output = DeepDiff(template_entity, nifi_template, ignore_order=True) + # assert len(diff_output['type_changes']) == 6 + + +def test_load_template_from_file_path_bad_path(): + with pytest.raises(AssertionError): + nipyapi.templates.load_template_from_xml_file_path('nothing-to-see-here.nope') + with pytest.raises(AssertionError): + # TODO: fix so that we can test None as well + nipyapi.templates.load_template_from_xml_file_path("") + + +def test_load_template_from_xml_file(fix_templates): + with open(fix_templates.c_file, "r") as template_file: + template_entity = nipyapi.templates.load_template_from_xml_file_stream(template_file) + assert isinstance(template_entity, nipyapi.nifi.TemplateEntity) + + +def test_load_template_from_xml_string(fix_templates): + with open(fix_templates.c_file, "r") as template_file: + data = template_file.read() + template_entity = nipyapi.templates.load_template_from_xml_string(data) + assert isinstance(template_entity, nipyapi.nifi.TemplateEntity) + + +def test_load_template_from_xml_really_json_string(): + from pyexpat import ExpatError + with pytest.raises(ExpatError): + nipyapi.templates.load_template_from_xml_string("{'foo':'bar'}") From 1353624fa8b0e85ab94ad4a16f747545214ce731 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Fri, 6 Nov 2020 12:26:28 +0000 Subject: [PATCH 37/40] Merge 0.15.0 release from Next to Master (#228) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add greedy control to get_processor to support exact matching on get operation Add basicAuth support to nifi client and security module * Add greedy control to several get_ functions to support exact matching on operation Add basicAuth support to nifi client and security module Updated test containers to 1.11.4 Added special case for 'root' to get_processor Corrected list_invalid_processors to correctly report an empty list update_controller now has a refresh option get_template now correctly returns None if Template not found is_endpoint_up now has a reasonable default timeout automatically trim API endpoint URLs of trailing slash to avoid really really annoying errors * Added configuration control for NiFi Authentication mode, either tokenAuth or basicAuth Improved Linting and Logging statements in security.py * Adding vscode to gitignore because OSX is bloody stupid and invasive * Bump version: 0.14.1 → 0.14.2 * Bump version: 0.14.2 → 0.14.3 * Add greedy control to get_processor to support exact matching on get operation Add basicAuth support to nifi client and security module * Added configuration control for NiFi Authentication mode, either tokenAuth or basicAuth Improved Linting and Logging statements in security.py * Update base clients to NiFi-1.12.1 and Registry-0.7.0 * Add greedy control to get_processor to support exact matching on get operation Add basicAuth support to nifi client and security module * Added configuration control for NiFi Authentication mode, either tokenAuth or basicAuth Improved Linting and Logging statements in security.py * Update base clients to NiFi-1.12.1 and Registry-0.7.0 * Updated contributing.rst to include guidance on new features going into Next branch Added create and delete port to _all_ in canvas.py. Fixes #192 Coding style fixes. * Bump version: 0.14.3 → 0.15.0 * Doc fixes for release Update history for release --- docs/contributing.rst | 1 + docs/history.rst | 13 + docs/nipyapi-docs/nipyapi.nifi.apis.rst | 4 +- docs/nipyapi-docs/nipyapi.nifi.models.rst | 24 - docs/nipyapi-docs/nipyapi.registry.models.rst | 24 - nipyapi/__init__.py | 2 +- nipyapi/canvas.py | 15 +- nipyapi/nifi/__init__.py | 10 +- nipyapi/nifi/api_client.py | 4 +- nipyapi/nifi/apis/access_api.py | 6 +- nipyapi/nifi/apis/connections_api.py | 14 +- nipyapi/nifi/apis/controller_api.py | 58 +- nipyapi/nifi/apis/controller_services_api.py | 38 +- nipyapi/nifi/apis/counters_api.py | 2 +- nipyapi/nifi/apis/data_transfer_api.py | 30 +- nipyapi/nifi/apis/flow_api.py | 238 +- nipyapi/nifi/apis/flowfile_queues_api.py | 34 +- nipyapi/nifi/apis/funnel_api.py | 14 +- nipyapi/nifi/apis/input_ports_api.py | 18 +- nipyapi/nifi/apis/labels_api.py | 14 +- nipyapi/nifi/apis/output_ports_api.py | 18 +- nipyapi/nifi/apis/parameter_contexts_api.py | 14 +- nipyapi/nifi/apis/policies_api.py | 18 +- nipyapi/nifi/apis/process_groups_api.py | 940 +- nipyapi/nifi/apis/processors_api.py | 137 +- nipyapi/nifi/apis/provenance_api.py | 22 +- nipyapi/nifi/apis/provenance_events_api.py | 18 +- .../nifi/apis/remote_process_groups_api.py | 22 +- nipyapi/nifi/apis/reporting_tasks_api.py | 30 +- nipyapi/nifi/apis/resources_api.py | 6 +- nipyapi/nifi/apis/site_to_site_api.py | 10 +- nipyapi/nifi/apis/snippets_api.py | 14 +- nipyapi/nifi/apis/system_diagnostics_api.py | 6 +- nipyapi/nifi/apis/templates_api.py | 10 +- nipyapi/nifi/apis/tenants_api.py | 2 +- nipyapi/nifi/apis/versions_api.py | 6 +- nipyapi/nifi/configuration.py | 8 +- nipyapi/nifi/models/__init__.py | 10 +- nipyapi/nifi/models/about_dto.py | 2 +- nipyapi/nifi/models/about_entity.py | 2 +- .../nifi/models/access_configuration_dto.py | 2 +- .../models/access_configuration_entity.py | 2 +- nipyapi/nifi/models/access_policy_dto.py | 2 +- nipyapi/nifi/models/access_policy_entity.py | 2 +- .../nifi/models/access_policy_summary_dto.py | 2 +- .../models/access_policy_summary_entity.py | 2 +- nipyapi/nifi/models/access_status_dto.py | 2 +- nipyapi/nifi/models/access_status_entity.py | 2 +- nipyapi/nifi/models/action_details_dto.py | 6 +- nipyapi/nifi/models/action_dto.py | 2 +- nipyapi/nifi/models/action_entity.py | 2 +- .../activate_controller_services_entity.py | 2 +- nipyapi/nifi/models/affected_component_dto.py | 2 +- .../nifi/models/affected_component_entity.py | 2 +- nipyapi/nifi/models/allowable_value_dto.py | 2 +- nipyapi/nifi/models/allowable_value_entity.py | 2 +- nipyapi/nifi/models/attribute_dto.py | 2 +- nipyapi/nifi/models/banner_dto.py | 2 +- nipyapi/nifi/models/banner_entity.py | 2 +- nipyapi/nifi/models/batch_settings_dto.py | 2 +- nipyapi/nifi/models/batch_size.py | 2 +- nipyapi/nifi/models/bucket.py | 36 +- nipyapi/nifi/models/bucket_dto.py | 2 +- nipyapi/nifi/models/bucket_entity.py | 2 +- nipyapi/nifi/models/buckets_entity.py | 2 +- nipyapi/nifi/models/bulletin_board_dto.py | 2 +- nipyapi/nifi/models/bulletin_board_entity.py | 2 +- nipyapi/nifi/models/bulletin_dto.py | 2 +- nipyapi/nifi/models/bulletin_entity.py | 2 +- nipyapi/nifi/models/bundle.py | 2 +- nipyapi/nifi/models/bundle_dto.py | 2 +- nipyapi/nifi/models/cluste_summary_entity.py | 2 +- nipyapi/nifi/models/cluster_dto.py | 2 +- nipyapi/nifi/models/cluster_entity.py | 2 +- .../models/cluster_search_results_entity.py | 2 +- nipyapi/nifi/models/cluster_summary_dto.py | 2 +- nipyapi/nifi/models/component_details_dto.py | 6 +- .../nifi/models/component_difference_dto.py | 2 +- nipyapi/nifi/models/component_history_dto.py | 2 +- .../nifi/models/component_history_entity.py | 2 +- .../nifi/models/component_reference_dto.py | 2 +- .../nifi/models/component_reference_entity.py | 2 +- .../component_restriction_permission_dto.py | 2 +- .../models/component_search_result_dto.py | 2 +- nipyapi/nifi/models/component_state_dto.py | 2 +- nipyapi/nifi/models/component_state_entity.py | 2 +- .../models/component_validation_result_dto.py | 2 +- .../component_validation_result_entity.py | 2 +- .../component_validation_results_entity.py | 2 +- nipyapi/nifi/models/connectable_component.py | 2 +- nipyapi/nifi/models/connectable_dto.py | 2 +- nipyapi/nifi/models/connection_dto.py | 2 +- nipyapi/nifi/models/connection_entity.py | 2 +- .../nifi/models/connection_statistics_dto.py | 2 +- .../models/connection_statistics_entity.py | 2 +- .../connection_statistics_snapshot_dto.py | 2 +- nipyapi/nifi/models/connection_status_dto.py | 2 +- .../nifi/models/connection_status_entity.py | 2 +- ...nection_status_predictions_snapshot_dto.py | 2 +- .../models/connection_status_snapshot_dto.py | 2 +- .../connection_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/connections_entity.py | 2 +- .../models/controller_bulletins_entity.py | 2 +- .../models/controller_configuration_dto.py | 2 +- .../models/controller_configuration_entity.py | 2 +- nipyapi/nifi/models/controller_dto.py | 2 +- nipyapi/nifi/models/controller_entity.py | 2 +- nipyapi/nifi/models/controller_service_api.py | 2 +- .../nifi/models/controller_service_api_dto.py | 2 +- nipyapi/nifi/models/controller_service_dto.py | 2 +- .../nifi/models/controller_service_entity.py | 2 +- ...oller_service_referencing_component_dto.py | 2 +- ...er_service_referencing_component_entity.py | 2 +- ...r_service_referencing_components_entity.py | 2 +- .../controller_service_run_status_entity.py | 2 +- .../models/controller_service_status_dto.py | 2 +- .../models/controller_service_types_entity.py | 2 +- .../nifi/models/controller_services_entity.py | 2 +- nipyapi/nifi/models/controller_status_dto.py | 2 +- .../nifi/models/controller_status_entity.py | 2 +- .../models/copy_snippet_request_entity.py | 2 +- nipyapi/nifi/models/counter_dto.py | 2 +- nipyapi/nifi/models/counter_entity.py | 2 +- nipyapi/nifi/models/counters_dto.py | 2 +- nipyapi/nifi/models/counters_entity.py | 2 +- nipyapi/nifi/models/counters_snapshot_dto.py | 2 +- .../models/create_active_request_entity.py | 2 +- .../models/create_template_request_entity.py | 2 +- nipyapi/nifi/models/current_user_entity.py | 2 +- nipyapi/nifi/models/difference_dto.py | 2 +- nipyapi/nifi/models/dimensions_dto.py | 2 +- nipyapi/nifi/models/documented_type_dto.py | 2 +- nipyapi/nifi/models/drop_request_dto.py | 2 +- nipyapi/nifi/models/drop_request_entity.py | 2 +- .../nifi/models/explicit_restriction_dto.py | 2 +- .../external_controller_service_reference.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_dto.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_entity.py | 2 +- nipyapi/nifi/models/flow_comparison_entity.py | 2 +- nipyapi/nifi/models/flow_configuration_dto.py | 2 +- .../nifi/models/flow_configuration_entity.py | 2 +- nipyapi/nifi/models/flow_dto.py | 2 +- nipyapi/nifi/models/flow_entity.py | 2 +- nipyapi/nifi/models/flow_file_dto.py | 2 +- nipyapi/nifi/models/flow_file_entity.py | 2 +- nipyapi/nifi/models/flow_file_summary_dto.py | 2 +- nipyapi/nifi/models/flow_snippet_dto.py | 2 +- nipyapi/nifi/models/funnel_dto.py | 2 +- nipyapi/nifi/models/funnel_entity.py | 2 +- nipyapi/nifi/models/funnels_entity.py | 2 +- nipyapi/nifi/models/garbage_collection_dto.py | 2 +- nipyapi/nifi/models/history_dto.py | 2 +- nipyapi/nifi/models/history_entity.py | 2 +- nipyapi/nifi/models/input_ports_entity.py | 2 +- .../instantiate_template_request_entity.py | 2 +- nipyapi/nifi/models/jaxb_link.py | 2 +- nipyapi/nifi/models/label_dto.py | 2 +- nipyapi/nifi/models/label_entity.py | 2 +- nipyapi/nifi/models/labels_entity.py | 2 +- nipyapi/nifi/models/lineage_dto.py | 2 +- nipyapi/nifi/models/lineage_entity.py | 2 +- nipyapi/nifi/models/lineage_request_dto.py | 2 +- nipyapi/nifi/models/lineage_results_dto.py | 2 +- nipyapi/nifi/models/listing_request_dto.py | 62 +- nipyapi/nifi/models/listing_request_entity.py | 2 +- ...node_connection_statistics_snapshot_dto.py | 2 +- .../node_connection_status_snapshot_dto.py | 2 +- .../nifi/models/node_counters_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_dto.py | 2 +- nipyapi/nifi/models/node_entity.py | 2 +- nipyapi/nifi/models/node_event_dto.py | 2 +- .../models/node_port_status_snapshot_dto.py | 2 +- .../node_process_group_status_snapshot_dto.py | 2 +- .../node_processor_status_snapshot_dto.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_search_result_dto.py | 2 +- .../nifi/models/node_status_snapshots_dto.py | 2 +- .../node_system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/output_ports_entity.py | 2 +- nipyapi/nifi/models/parameter_context_dto.py | 2 +- .../nifi/models/parameter_context_entity.py | 2 +- .../models/parameter_context_reference_dto.py | 2 +- .../parameter_context_reference_entity.py | 2 +- .../parameter_context_update_request_dto.py | 2 +- ...parameter_context_update_request_entity.py | 2 +- .../parameter_context_update_step_dto.py | 2 +- ...arameter_context_validation_request_dto.py | 2 +- ...meter_context_validation_request_entity.py | 2 +- .../parameter_context_validation_step_dto.py | 2 +- .../nifi/models/parameter_contexts_entity.py | 2 +- nipyapi/nifi/models/parameter_dto.py | 2 +- nipyapi/nifi/models/parameter_entity.py | 2 +- nipyapi/nifi/models/peer_dto.py | 2 +- nipyapi/nifi/models/peers_entity.py | 2 +- nipyapi/nifi/models/permissions.py | 2 +- nipyapi/nifi/models/permissions_dto.py | 2 +- nipyapi/nifi/models/port_dto.py | 2 +- nipyapi/nifi/models/port_entity.py | 2 +- nipyapi/nifi/models/port_run_status_entity.py | 2 +- nipyapi/nifi/models/port_status_dto.py | 2 +- nipyapi/nifi/models/port_status_entity.py | 2 +- .../nifi/models/port_status_snapshot_dto.py | 2 +- .../models/port_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/position.py | 2 +- nipyapi/nifi/models/position_dto.py | 2 +- nipyapi/nifi/models/previous_value_dto.py | 2 +- .../nifi/models/prioritizer_types_entity.py | 2 +- nipyapi/nifi/models/process_group_dto.py | 72 +- nipyapi/nifi/models/process_group_entity.py | 2 +- nipyapi/nifi/models/process_group_flow_dto.py | 2 +- .../nifi/models/process_group_flow_entity.py | 2 +- .../models/process_group_import_entity.py | 181 + nipyapi/nifi/models/process_group_name_dto.py | 2 +- .../process_group_replace_request_dto.py | 321 + .../process_group_replace_request_entity.py | 181 + .../nifi/models/process_group_status_dto.py | 2 +- .../models/process_group_status_entity.py | 2 +- .../process_group_status_snapshot_dto.py | 2 +- .../process_group_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/process_groups_entity.py | 2 +- nipyapi/nifi/models/processor_config_dto.py | 2 +- nipyapi/nifi/models/processor_dto.py | 2 +- nipyapi/nifi/models/processor_entity.py | 2 +- .../processor_run_status_details_dto.py | 243 + .../processor_run_status_details_entity.py | 181 + .../models/processor_run_status_entity.py | 2 +- nipyapi/nifi/models/processor_status_dto.py | 2 +- .../nifi/models/processor_status_entity.py | 2 +- .../models/processor_status_snapshot_dto.py | 2 +- .../processor_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/processor_types_entity.py | 2 +- nipyapi/nifi/models/processors_entity.py | 2 +- .../processors_run_status_details_entity.py | 123 + .../nifi/models/property_descriptor_dto.py | 2 +- .../nifi/models/property_descriptor_entity.py | 2 +- nipyapi/nifi/models/property_history_dto.py | 2 +- nipyapi/nifi/models/provenance_dto.py | 2 +- nipyapi/nifi/models/provenance_entity.py | 2 +- nipyapi/nifi/models/provenance_event_dto.py | 2 +- .../nifi/models/provenance_event_entity.py | 2 +- nipyapi/nifi/models/provenance_link_dto.py | 2 +- nipyapi/nifi/models/provenance_node_dto.py | 2 +- nipyapi/nifi/models/provenance_options_dto.py | 2 +- .../nifi/models/provenance_options_entity.py | 2 +- nipyapi/nifi/models/provenance_request_dto.py | 2 +- nipyapi/nifi/models/provenance_results_dto.py | 2 +- .../models/provenance_searchable_field_dto.py | 2 +- nipyapi/nifi/models/queue_size_dto.py | 2 +- nipyapi/nifi/models/registry_client_entity.py | 2 +- .../nifi/models/registry_clients_entity.py | 2 +- nipyapi/nifi/models/registry_dto.py | 2 +- nipyapi/nifi/models/relationship_dto.py | 2 +- .../models/remote_port_run_status_entity.py | 2 +- .../remote_process_group_contents_dto.py | 2 +- .../nifi/models/remote_process_group_dto.py | 2 +- .../models/remote_process_group_entity.py | 2 +- .../models/remote_process_group_port_dto.py | 2 +- .../remote_process_group_port_entity.py | 2 +- .../models/remote_process_group_status_dto.py | 2 +- .../remote_process_group_status_entity.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- ...te_process_group_status_snapshot_entity.py | 2 +- .../models/remote_process_groups_entity.py | 2 +- nipyapi/nifi/models/reporting_task_dto.py | 2 +- nipyapi/nifi/models/reporting_task_entity.py | 2 +- .../reporting_task_run_status_entity.py | 2 +- .../nifi/models/reporting_task_status_dto.py | 2 +- .../models/reporting_task_types_entity.py | 2 +- nipyapi/nifi/models/reporting_tasks_entity.py | 2 +- .../nifi/models/required_permission_dto.py | 2 +- nipyapi/nifi/models/resource_dto.py | 2 +- nipyapi/nifi/models/resources_entity.py | 2 +- nipyapi/nifi/models/revision_dto.py | 2 +- nipyapi/nifi/models/revision_info.py | 181 + .../run_status_details_request_entity.py | 125 + .../nifi/models/schedule_components_entity.py | 2 +- .../nifi/models/search_result_group_dto.py | 2 +- nipyapi/nifi/models/search_results_dto.py | 60 +- nipyapi/nifi/models/search_results_entity.py | 2 +- nipyapi/nifi/models/snippet_dto.py | 2 +- nipyapi/nifi/models/snippet_entity.py | 2 +- .../start_version_control_request_entity.py | 2 +- nipyapi/nifi/models/state_entry_dto.py | 2 +- nipyapi/nifi/models/state_map_dto.py | 2 +- nipyapi/nifi/models/status_descriptor_dto.py | 2 +- nipyapi/nifi/models/status_history_dto.py | 2 +- nipyapi/nifi/models/status_history_entity.py | 2 +- nipyapi/nifi/models/status_snapshot_dto.py | 2 +- nipyapi/nifi/models/storage_usage_dto.py | 2 +- nipyapi/nifi/models/streaming_output.py | 6 +- .../models/submit_replay_request_entity.py | 2 +- nipyapi/nifi/models/system_diagnostics_dto.py | 2 +- .../nifi/models/system_diagnostics_entity.py | 2 +- .../models/system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/template_dto.py | 2 +- nipyapi/nifi/models/template_entity.py | 2 +- nipyapi/nifi/models/templates_entity.py | 2 +- nipyapi/nifi/models/tenant_dto.py | 2 +- nipyapi/nifi/models/tenant_entity.py | 2 +- nipyapi/nifi/models/tenants_entity.py | 2 +- .../nifi/models/transaction_result_entity.py | 2 +- ...roller_service_reference_request_entity.py | 2 +- nipyapi/nifi/models/user_dto.py | 2 +- nipyapi/nifi/models/user_entity.py | 2 +- nipyapi/nifi/models/user_group_dto.py | 2 +- nipyapi/nifi/models/user_group_entity.py | 2 +- nipyapi/nifi/models/user_groups_entity.py | 2 +- nipyapi/nifi/models/users_entity.py | 2 +- nipyapi/nifi/models/variable_dto.py | 2 +- nipyapi/nifi/models/variable_entity.py | 2 +- nipyapi/nifi/models/variable_registry_dto.py | 2 +- .../nifi/models/variable_registry_entity.py | 2 +- .../variable_registry_update_request_dto.py | 2 +- ...variable_registry_update_request_entity.py | 2 +- .../variable_registry_update_step_dto.py | 2 +- ...ersion_control_component_mapping_entity.py | 2 +- .../models/version_control_information_dto.py | 2 +- .../version_control_information_entity.py | 64 +- nipyapi/nifi/models/version_info_dto.py | 2 +- nipyapi/nifi/models/versioned_connection.py | 2 +- .../models/versioned_controller_service.py | 2 +- nipyapi/nifi/models/versioned_flow.py | 36 +- .../nifi/models/versioned_flow_coordinates.py | 2 +- nipyapi/nifi/models/versioned_flow_dto.py | 2 +- nipyapi/nifi/models/versioned_flow_entity.py | 2 +- .../nifi/models/versioned_flow_snapshot.py | 2 +- .../models/versioned_flow_snapshot_entity.py | 2 +- .../versioned_flow_snapshot_metadata.py | 2 +- ...versioned_flow_snapshot_metadata_entity.py | 2 +- ...ioned_flow_snapshot_metadata_set_entity.py | 2 +- .../versioned_flow_update_request_dto.py | 6 +- .../versioned_flow_update_request_entity.py | 68 +- nipyapi/nifi/models/versioned_flows_entity.py | 2 +- nipyapi/nifi/models/versioned_funnel.py | 2 +- nipyapi/nifi/models/versioned_label.py | 2 +- nipyapi/nifi/models/versioned_parameter.py | 2 +- .../models/versioned_parameter_context.py | 2 +- nipyapi/nifi/models/versioned_port.py | 2 +- .../nifi/models/versioned_process_group.py | 60 +- nipyapi/nifi/models/versioned_processor.py | 2 +- .../models/versioned_property_descriptor.py | 2 +- .../models/versioned_remote_group_port.py | 2 +- .../models/versioned_remote_process_group.py | 2 +- nipyapi/nifi/rest.py | 2 +- nipyapi/registry/__init__.py | 3 +- nipyapi/registry/api_client.py | 2 +- nipyapi/registry/apis/access_api.py | 114 +- nipyapi/registry/apis/bucket_bundles_api.py | 6 +- nipyapi/registry/apis/bucket_flows_api.py | 34 +- nipyapi/registry/apis/buckets_api.py | 24 +- nipyapi/registry/apis/bundles_api.py | 26 +- nipyapi/registry/apis/config_api.py | 4 +- .../registry/apis/extension_repository_api.py | 26 +- nipyapi/registry/apis/extensions_api.py | 8 +- nipyapi/registry/apis/flows_api.py | 14 +- nipyapi/registry/apis/items_api.py | 8 +- nipyapi/registry/apis/policies_api.py | 26 +- nipyapi/registry/apis/tenants_api.py | 42 +- nipyapi/registry/configuration.py | 29 +- nipyapi/registry/models/__init__.py | 3 +- nipyapi/registry/models/access_policy.py | 32 +- .../registry/models/access_policy_summary.py | 36 +- nipyapi/registry/models/allowable_value.py | 2 +- nipyapi/registry/models/attribute.py | 2 +- nipyapi/registry/models/batch_size.py | 2 +- nipyapi/registry/models/bucket.py | 36 +- nipyapi/registry/models/bucket_item.py | 2 +- nipyapi/registry/models/build_info.py | 2 +- nipyapi/registry/models/bundle.py | 2 +- nipyapi/registry/models/bundle_info.py | 2 +- nipyapi/registry/models/bundle_version.py | 2 +- .../models/bundle_version_dependency.py | 2 +- .../models/bundle_version_metadata.py | 2 +- .../registry/models/component_difference.py | 2 +- .../models/component_difference_group.py | 2 +- .../registry/models/connectable_component.py | 2 +- .../registry/models/controller_service_api.py | 2 +- .../models/controller_service_definition.py | 2 +- nipyapi/registry/models/current_user.py | 2 +- nipyapi/registry/models/deprecation_notice.py | 2 +- nipyapi/registry/models/dynamic_property.py | 2 +- .../registry/models/dynamic_relationship.py | 2 +- nipyapi/registry/models/extension.py | 2 +- nipyapi/registry/models/extension_bundle.py | 2 +- .../models/extension_filter_params.py | 2 +- nipyapi/registry/models/extension_metadata.py | 2 +- .../models/extension_metadata_container.py | 2 +- .../models/extension_repo_artifact.py | 2 +- .../registry/models/extension_repo_bucket.py | 2 +- .../registry/models/extension_repo_group.py | 2 +- .../registry/models/extension_repo_version.py | 2 +- .../models/extension_repo_version_summary.py | 2 +- .../external_controller_service_reference.py | 2 +- nipyapi/registry/models/fields.py | 2 +- nipyapi/registry/models/jaxb_link.py | 2 +- nipyapi/registry/models/model_property.py | 2 +- nipyapi/registry/models/permissions.py | 2 +- nipyapi/registry/models/position.py | 2 +- .../registry/models/provided_service_api.py | 2 +- .../registry/models/registry_configuration.py | 2 +- nipyapi/registry/models/relationship.py | 2 +- nipyapi/registry/models/resource.py | 2 +- .../registry/models/resource_permissions.py | 2 +- nipyapi/registry/models/restricted.py | 2 +- nipyapi/registry/models/restriction.py | 2 +- nipyapi/registry/models/revision_info.py | 181 + nipyapi/registry/models/stateful.py | 2 +- .../models/system_resource_consideration.py | 2 +- nipyapi/registry/models/tag_count.py | 2 +- nipyapi/registry/models/tenant.py | 36 +- nipyapi/registry/models/user.py | 32 +- nipyapi/registry/models/user_group.py | 32 +- .../registry/models/versioned_connection.py | 2 +- .../models/versioned_controller_service.py | 2 +- nipyapi/registry/models/versioned_flow.py | 36 +- .../models/versioned_flow_coordinates.py | 2 +- .../models/versioned_flow_difference.py | 2 +- .../models/versioned_flow_snapshot.py | 2 +- .../versioned_flow_snapshot_metadata.py | 2 +- nipyapi/registry/models/versioned_funnel.py | 2 +- nipyapi/registry/models/versioned_label.py | 2 +- .../registry/models/versioned_parameter.py | 2 +- .../models/versioned_parameter_context.py | 2 +- nipyapi/registry/models/versioned_port.py | 2 +- .../models/versioned_process_group.py | 60 +- .../registry/models/versioned_processor.py | 2 +- .../models/versioned_property_descriptor.py | 2 +- .../models/versioned_remote_group_port.py | 2 +- .../models/versioned_remote_process_group.py | 2 +- nipyapi/registry/rest.py | 2 +- nipyapi/security.py | 15 +- nipyapi/utils.py | 2 - .../client_gen/api_defs/nifi-1.12.1.json | 21364 ++++++++++++++++ .../client_gen/api_defs/registry-0.7.0.json | 6485 +++++ resources/client_gen/generate_api_client.sh | 2 +- resources/docker/latest/docker-compose.yml | 4 +- resources/docker/secure/docker-compose.yml | 4 +- resources/docker/tox-full/docker-compose.yml | 4 +- setup.cfg | 3 +- setup.py | 2 +- 440 files changed, 32238 insertions(+), 1063 deletions(-) create mode 100644 nipyapi/nifi/models/process_group_import_entity.py create mode 100644 nipyapi/nifi/models/process_group_replace_request_dto.py create mode 100644 nipyapi/nifi/models/process_group_replace_request_entity.py create mode 100644 nipyapi/nifi/models/processor_run_status_details_dto.py create mode 100644 nipyapi/nifi/models/processor_run_status_details_entity.py create mode 100644 nipyapi/nifi/models/processors_run_status_details_entity.py create mode 100644 nipyapi/nifi/models/revision_info.py create mode 100644 nipyapi/nifi/models/run_status_details_request_entity.py create mode 100644 nipyapi/registry/models/revision_info.py create mode 100644 resources/client_gen/api_defs/nifi-1.12.1.json create mode 100644 resources/client_gen/api_defs/registry-0.7.0.json diff --git a/docs/contributing.rst b/docs/contributing.rst index 4fc845b4..1d9efb73 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -118,3 +118,4 @@ Before you submit a pull request, check that it meets these guidelines: 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. diff --git a/docs/history.rst b/docs/history.rst index 8ef2690f..84eeacd5 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,19 @@ History ======= +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) ------------------- diff --git a/docs/nipyapi-docs/nipyapi.nifi.apis.rst b/docs/nipyapi-docs/nipyapi.nifi.apis.rst index 9b5a1a5d..ccdd8dd4 100644 --- a/docs/nipyapi-docs/nipyapi.nifi.apis.rst +++ b/docs/nipyapi-docs/nipyapi.nifi.apis.rst @@ -101,13 +101,13 @@ nipyapi.nifi.apis.output\_ports\_api module :show-inheritance: nipyapi.nifi.apis.parameter\_contexts\_api module --------------------------------------- +------------------------------------------------- .. automodule:: nipyapi.nifi.apis.parameter_contexts_api :members: :undoc-members: :show-inheritance: - + nipyapi.nifi.apis.policies\_api module -------------------------------------- diff --git a/docs/nipyapi-docs/nipyapi.nifi.models.rst b/docs/nipyapi-docs/nipyapi.nifi.models.rst index b24e20d8..123ae321 100644 --- a/docs/nipyapi-docs/nipyapi.nifi.models.rst +++ b/docs/nipyapi-docs/nipyapi.nifi.models.rst @@ -900,14 +900,6 @@ nipyapi.nifi.models.lineage\_results\_dto module :undoc-members: :show-inheritance: -nipyapi.nifi.models.link module -------------------------------- - -.. automodule:: nipyapi.nifi.models.link - :members: - :undoc-members: - :show-inheritance: - nipyapi.nifi.models.listing\_request\_dto module ------------------------------------------------ @@ -1756,14 +1748,6 @@ nipyapi.nifi.models.tenants\_entity module :undoc-members: :show-inheritance: -nipyapi.nifi.models.the\_position\_of\_a\_component\_on\_the\_graph module --------------------------------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.the_position_of_a_component_on_the_graph - :members: - :undoc-members: - :show-inheritance: - nipyapi.nifi.models.transaction\_result\_entity module ------------------------------------------------------ @@ -1780,14 +1764,6 @@ nipyapi.nifi.models.update\_controller\_service\_reference\_request\_entity modu :undoc-members: :show-inheritance: -nipyapi.nifi.models.uri\_builder module ---------------------------------------- - -.. automodule:: nipyapi.nifi.models.uri_builder - :members: - :undoc-members: - :show-inheritance: - nipyapi.nifi.models.user\_dto module ------------------------------------ diff --git a/docs/nipyapi-docs/nipyapi.registry.models.rst b/docs/nipyapi-docs/nipyapi.registry.models.rst index ce03b342..447965cf 100644 --- a/docs/nipyapi-docs/nipyapi.registry.models.rst +++ b/docs/nipyapi-docs/nipyapi.registry.models.rst @@ -84,14 +84,6 @@ nipyapi.registry.models.fields module :undoc-members: :show-inheritance: -nipyapi.registry.models.link module ------------------------------------ - -.. automodule:: nipyapi.registry.models.link - :members: - :undoc-members: - :show-inheritance: - nipyapi.registry.models.permissions module ------------------------------------------ @@ -124,22 +116,6 @@ nipyapi.registry.models.tenant module :undoc-members: :show-inheritance: -nipyapi.registry.models.the\_position\_of\_a\_component\_on\_the\_graph module ------------------------------------------------------------------------------- - -.. automodule:: nipyapi.registry.models.the_position_of_a_component_on_the_graph - :members: - :undoc-members: - :show-inheritance: - -nipyapi.registry.models.uri\_builder module -------------------------------------------- - -.. automodule:: nipyapi.registry.models.uri_builder - :members: - :undoc-members: - :show-inheritance: - nipyapi.registry.models.user module ----------------------------------- diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index 32fdd24c..7eb10ba0 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.14.3' +__version__ = '0.15.0' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security'] diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 1f83998f..ceece3eb 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -26,7 +26,8 @@ 'list_all_funnels', 'list_all_remote_process_groups', 'delete_funnel', 'get_remote_process_group', 'update_process_group', 'create_funnel', 'create_remote_process_group', 'delete_remote_process_group', - 'set_remote_process_group_transmission', 'get_pg_parents_ids' + 'set_remote_process_group_transmission', 'get_pg_parents_ids', + 'delete_port', 'create_port' ] log = logging.getLogger(__name__) @@ -1169,7 +1170,7 @@ def _del_cont(cont_id): return result -def update_controller(controller, update, refresh=True): +def update_controller(controller, update): """ Updates the Configuration of a Controller Service @@ -1177,7 +1178,6 @@ def update_controller(controller, update, refresh=True): controller (ControllerServiceEntity): Target Controller to update update (ControllerServiceDTO): Controller Service configuration object containing the new config params and properties - refresh (bool): True to refresh before applying Returns: (ControllerServiceEntity) @@ -1186,8 +1186,6 @@ def update_controller(controller, update, refresh=True): assert isinstance(controller, nipyapi.nifi.ControllerServiceEntity) assert isinstance(update, nipyapi.nifi.ControllerServiceDTO) # Insert the ID into the update - if refresh: - controller = get_controller(controller.id, 'id') update.id = controller.id return nipyapi.nifi.ControllerServicesApi().update_controller_service( id=controller.id, @@ -1258,8 +1256,7 @@ def _schedule_controller_state(cont_id, tgt_state): raise ValueError("Scheduling request timed out") -def get_controller(identifier, identifier_type='name', - bool_response=False, greedy=True): +def get_controller(identifier, identifier_type='name', bool_response=False): """ Retrieve a given Controller @@ -1268,7 +1265,6 @@ def get_controller(identifier, identifier_type='name', 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 - greedy (bool): True for partial match, False for exact match Returns: @@ -1281,8 +1277,7 @@ def get_controller(identifier, identifier_type='name', out = handle.get_controller_service(identifier) else: obj = list_all_controllers() - out = nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=greedy) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type) except nipyapi.nifi.rest.ApiException as e: if bool_response: return False diff --git a/nipyapi/nifi/__init__.py b/nipyapi/nifi/__init__.py index 1a569c98..453be979 100644 --- a/nipyapi/nifi/__init__.py +++ b/nipyapi/nifi/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -187,7 +187,10 @@ from .models.process_group_entity import ProcessGroupEntity from .models.process_group_flow_dto import ProcessGroupFlowDTO from .models.process_group_flow_entity import ProcessGroupFlowEntity +from .models.process_group_import_entity import ProcessGroupImportEntity from .models.process_group_name_dto import ProcessGroupNameDTO +from .models.process_group_replace_request_dto import ProcessGroupReplaceRequestDTO +from .models.process_group_replace_request_entity import ProcessGroupReplaceRequestEntity from .models.process_group_status_dto import ProcessGroupStatusDTO from .models.process_group_status_entity import ProcessGroupStatusEntity from .models.process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO @@ -196,6 +199,8 @@ from .models.processor_config_dto import ProcessorConfigDTO from .models.processor_dto import ProcessorDTO from .models.processor_entity import ProcessorEntity +from .models.processor_run_status_details_dto import ProcessorRunStatusDetailsDTO +from .models.processor_run_status_details_entity import ProcessorRunStatusDetailsEntity from .models.processor_run_status_entity import ProcessorRunStatusEntity from .models.processor_status_dto import ProcessorStatusDTO from .models.processor_status_entity import ProcessorStatusEntity @@ -203,6 +208,7 @@ from .models.processor_status_snapshot_entity import ProcessorStatusSnapshotEntity from .models.processor_types_entity import ProcessorTypesEntity from .models.processors_entity import ProcessorsEntity +from .models.processors_run_status_details_entity import ProcessorsRunStatusDetailsEntity from .models.property_descriptor_dto import PropertyDescriptorDTO from .models.property_descriptor_entity import PropertyDescriptorEntity from .models.property_history_dto import PropertyHistoryDTO @@ -243,6 +249,8 @@ from .models.resource_dto import ResourceDTO from .models.resources_entity import ResourcesEntity from .models.revision_dto import RevisionDTO +from .models.revision_info import RevisionInfo +from .models.run_status_details_request_entity import RunStatusDetailsRequestEntity from .models.schedule_components_entity import ScheduleComponentsEntity from .models.search_result_group_dto import SearchResultGroupDTO from .models.search_results_dto import SearchResultsDTO diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index a4e0d1aa..0755c822 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -4,7 +4,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -628,6 +628,6 @@ def __deserialize_model(self, data, klass): value = data[klass.attribute_map[attr]] kwargs[attr] = self.__deserialize(value, attr_type) - instance = klass(**kwargs) + instance = klass(**kwargs) return instance diff --git a/nipyapi/nifi/apis/access_api.py b/nipyapi/nifi/apis/access_api.py index c7e7624e..d722defa 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -542,7 +542,7 @@ def get_access_status_with_http_info(self, **kwargs): def get_login_config(self, **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. @@ -567,7 +567,7 @@ def get_login_config(self, **kwargs): def get_login_config_with_http_info(self, **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. diff --git a/nipyapi/nifi/apis/connections_api.py b/nipyapi/nifi/apis/connections_api.py index bf316e07..ff0061dc 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def delete_connection(self, 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. @@ -72,7 +72,7 @@ def delete_connection(self, id, **kwargs): def delete_connection_with_http_info(self, 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. @@ -161,7 +161,7 @@ def delete_connection_with_http_info(self, id, **kwargs): def get_connection(self, 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. @@ -187,7 +187,7 @@ def get_connection(self, id, **kwargs): def get_connection_with_http_info(self, 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. @@ -267,7 +267,7 @@ def get_connection_with_http_info(self, id, **kwargs): def update_connection(self, 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. @@ -294,7 +294,7 @@ def update_connection(self, id, body, **kwargs): def update_connection_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index aa0802de..3ec2ef15 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def create_bulletin(self, 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. @@ -69,7 +69,7 @@ def create_bulletin(self, body, **kwargs): def create_bulletin_with_http_info(self, 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. @@ -149,7 +149,7 @@ def create_bulletin_with_http_info(self, body, **kwargs): def create_controller_service(self, 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. @@ -175,7 +175,7 @@ def create_controller_service(self, body, **kwargs): def create_controller_service_with_http_info(self, 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. @@ -255,7 +255,7 @@ def create_controller_service_with_http_info(self, body, **kwargs): def create_registry_client(self, 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. @@ -281,7 +281,7 @@ def create_registry_client(self, body, **kwargs): def create_registry_client_with_http_info(self, 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. @@ -361,7 +361,7 @@ def create_registry_client_with_http_info(self, body, **kwargs): def create_reporting_task(self, 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. @@ -387,7 +387,7 @@ def create_reporting_task(self, body, **kwargs): def create_reporting_task_with_http_info(self, 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. @@ -467,7 +467,7 @@ def create_reporting_task_with_http_info(self, body, **kwargs): def delete_history(self, 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. @@ -493,7 +493,7 @@ def delete_history(self, end_date, **kwargs): def delete_history_with_http_info(self, 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. @@ -573,7 +573,7 @@ def delete_history_with_http_info(self, end_date, **kwargs): def delete_node(self, 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. @@ -599,7 +599,7 @@ def delete_node(self, id, **kwargs): def delete_node_with_http_info(self, 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. @@ -679,7 +679,7 @@ def delete_node_with_http_info(self, id, **kwargs): def delete_registry_client(self, 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. @@ -708,7 +708,7 @@ def delete_registry_client(self, id, **kwargs): def delete_registry_client_with_http_info(self, 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. @@ -895,7 +895,7 @@ def get_cluster_with_http_info(self, **kwargs): def get_controller_config(self, **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. @@ -920,7 +920,7 @@ def get_controller_config(self, **kwargs): def get_controller_config_with_http_info(self, **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. @@ -993,7 +993,7 @@ def get_controller_config_with_http_info(self, **kwargs): def get_node(self, 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. @@ -1019,7 +1019,7 @@ def get_node(self, id, **kwargs): def get_node_with_http_info(self, 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. @@ -1099,7 +1099,7 @@ def get_node_with_http_info(self, id, **kwargs): def get_registry_client(self, 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. @@ -1125,7 +1125,7 @@ def get_registry_client(self, id, **kwargs): def get_registry_client_with_http_info(self, 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. @@ -1205,7 +1205,7 @@ def get_registry_client_with_http_info(self, id, **kwargs): def get_registry_clients(self, **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. @@ -1230,7 +1230,7 @@ def get_registry_clients(self, **kwargs): def get_registry_clients_with_http_info(self, **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. @@ -1303,7 +1303,7 @@ def get_registry_clients_with_http_info(self, **kwargs): def update_controller_config(self, 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. @@ -1329,7 +1329,7 @@ def update_controller_config(self, body, **kwargs): def update_controller_config_with_http_info(self, 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. @@ -1409,7 +1409,7 @@ def update_controller_config_with_http_info(self, body, **kwargs): def update_node(self, 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. @@ -1436,7 +1436,7 @@ def update_node(self, id, body, **kwargs): def update_node_with_http_info(self, 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. @@ -1522,7 +1522,7 @@ def update_node_with_http_info(self, id, body, **kwargs): def update_registry_client(self, 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. @@ -1549,7 +1549,7 @@ def update_registry_client(self, id, body, **kwargs): def update_registry_client_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/controller_services_api.py b/nipyapi/nifi/apis/controller_services_api.py index 8f84033e..bb04935a 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def clear_state(self, 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. @@ -69,7 +69,7 @@ def clear_state(self, id, **kwargs): def clear_state_with_http_info(self, 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. @@ -149,7 +149,7 @@ def clear_state_with_http_info(self, id, **kwargs): def get_controller_service(self, 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. @@ -175,7 +175,7 @@ def get_controller_service(self, id, **kwargs): def get_controller_service_with_http_info(self, 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. @@ -255,7 +255,7 @@ def get_controller_service_with_http_info(self, id, **kwargs): def get_controller_service_references(self, 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. @@ -281,7 +281,7 @@ def get_controller_service_references(self, id, **kwargs): def get_controller_service_references_with_http_info(self, 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. @@ -361,7 +361,7 @@ def get_controller_service_references_with_http_info(self, id, **kwargs): def get_property_descriptor(self, 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. @@ -388,7 +388,7 @@ def get_property_descriptor(self, id, property_name, **kwargs): def get_property_descriptor_with_http_info(self, 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. @@ -474,7 +474,7 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): def get_state(self, 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. @@ -500,7 +500,7 @@ def get_state(self, id, **kwargs): def get_state_with_http_info(self, 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. @@ -580,7 +580,7 @@ def get_state_with_http_info(self, id, **kwargs): def remove_controller_service(self, 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. @@ -609,7 +609,7 @@ def remove_controller_service(self, id, **kwargs): def remove_controller_service_with_http_info(self, 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. @@ -698,7 +698,7 @@ def remove_controller_service_with_http_info(self, id, **kwargs): def update_controller_service(self, 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. @@ -725,7 +725,7 @@ def update_controller_service(self, id, body, **kwargs): def update_controller_service_with_http_info(self, 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. @@ -811,7 +811,7 @@ def update_controller_service_with_http_info(self, id, body, **kwargs): def update_controller_service_references(self, 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. @@ -838,7 +838,7 @@ def update_controller_service_references(self, id, body, **kwargs): def update_controller_service_references_with_http_info(self, 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. @@ -924,7 +924,7 @@ def update_controller_service_references_with_http_info(self, id, body, **kwargs def update_run_status(self, 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. @@ -951,7 +951,7 @@ def update_run_status(self, id, body, **kwargs): def update_run_status_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/counters_api.py b/nipyapi/nifi/apis/counters_api.py index 69fb156c..5837dcac 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/data_transfer_api.py b/nipyapi/nifi/apis/data_transfer_api.py index ed44f9ff..8c417bf8 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def commit_input_port_transaction(self, 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. @@ -71,7 +71,7 @@ def commit_input_port_transaction(self, response_code, port_id, transaction_id, def commit_input_port_transaction_with_http_info(self, 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. @@ -163,7 +163,7 @@ def commit_input_port_transaction_with_http_info(self, response_code, port_id, t def commit_output_port_transaction(self, 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. @@ -192,7 +192,7 @@ def commit_output_port_transaction(self, response_code, checksum, port_id, trans def commit_output_port_transaction_with_http_info(self, 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. @@ -290,7 +290,7 @@ def commit_output_port_transaction_with_http_info(self, response_code, checksum, def create_port_transaction(self, 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. @@ -317,7 +317,7 @@ def create_port_transaction(self, port_type, port_id, **kwargs): def create_port_transaction_with_http_info(self, 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. @@ -399,7 +399,7 @@ def create_port_transaction_with_http_info(self, port_type, port_id, **kwargs): def extend_input_port_transaction_ttl(self, 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. @@ -426,7 +426,7 @@ def extend_input_port_transaction_ttl(self, port_id, transaction_id, **kwargs): def extend_input_port_transaction_ttl_with_http_info(self, 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. @@ -512,7 +512,7 @@ def extend_input_port_transaction_ttl_with_http_info(self, port_id, transaction_ def extend_output_port_transaction_ttl(self, 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. @@ -539,7 +539,7 @@ def extend_output_port_transaction_ttl(self, port_id, transaction_id, **kwargs): def extend_output_port_transaction_ttl_with_http_info(self, 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. @@ -625,7 +625,7 @@ def extend_output_port_transaction_ttl_with_http_info(self, port_id, transaction def receive_flow_files(self, 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. @@ -652,7 +652,7 @@ def receive_flow_files(self, port_id, transaction_id, **kwargs): def receive_flow_files_with_http_info(self, 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. @@ -738,7 +738,7 @@ def receive_flow_files_with_http_info(self, port_id, transaction_id, **kwargs): def transfer_flow_files(self, 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. @@ -765,7 +765,7 @@ def transfer_flow_files(self, port_id, transaction_id, **kwargs): def transfer_flow_files_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/flow_api.py b/nipyapi/nifi/apis/flow_api.py index de6c99ca..80344f67 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def activate_controller_services(self, 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. @@ -70,7 +70,7 @@ def activate_controller_services(self, id, body, **kwargs): def activate_controller_services_with_http_info(self, 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. @@ -156,7 +156,7 @@ def activate_controller_services_with_http_info(self, id, body, **kwargs): def generate_client_id(self, **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. @@ -181,7 +181,7 @@ def generate_client_id(self, **kwargs): def generate_client_id_with_http_info(self, **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. @@ -254,7 +254,7 @@ def generate_client_id_with_http_info(self, **kwargs): def get_about_info(self, **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. @@ -279,7 +279,7 @@ def get_about_info(self, **kwargs): def get_about_info_with_http_info(self, **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. @@ -458,7 +458,7 @@ def get_action_with_http_info(self, id, **kwargs): def get_banners(self, **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. @@ -483,7 +483,7 @@ def get_banners(self, **kwargs): def get_banners_with_http_info(self, **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. @@ -556,7 +556,7 @@ def get_banners_with_http_info(self, **kwargs): def get_buckets(self, 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. @@ -582,7 +582,7 @@ def get_buckets(self, id, **kwargs): def get_buckets_with_http_info(self, 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. @@ -662,7 +662,7 @@ def get_buckets_with_http_info(self, id, **kwargs): def get_bulletin_board(self, **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. @@ -693,7 +693,7 @@ def get_bulletin_board(self, **kwargs): def get_bulletin_board_with_http_info(self, **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. @@ -785,7 +785,7 @@ def get_bulletin_board_with_http_info(self, **kwargs): def get_bulletins(self, **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. @@ -810,7 +810,7 @@ def get_bulletins(self, **kwargs): def get_bulletins_with_http_info(self, **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. @@ -883,7 +883,7 @@ def get_bulletins_with_http_info(self, **kwargs): def get_cluster_summary(self, **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. @@ -908,7 +908,7 @@ def get_cluster_summary(self, **kwargs): def get_cluster_summary_with_http_info(self, **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. @@ -1087,7 +1087,7 @@ def get_component_history_with_http_info(self, component_id, **kwargs): def get_connection_statistics(self, 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. @@ -1115,7 +1115,7 @@ def get_connection_statistics(self, id, **kwargs): def get_connection_statistics_with_http_info(self, 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. @@ -1201,7 +1201,7 @@ def get_connection_statistics_with_http_info(self, id, **kwargs): def get_connection_status(self, 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. @@ -1229,7 +1229,7 @@ def get_connection_status(self, id, **kwargs): def get_connection_status_with_http_info(self, 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. @@ -1315,7 +1315,7 @@ def get_connection_status_with_http_info(self, id, **kwargs): def get_connection_status_history(self, 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. @@ -1341,7 +1341,7 @@ def get_connection_status_history(self, id, **kwargs): def get_connection_status_history_with_http_info(self, 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. @@ -1548,7 +1548,7 @@ def get_controller_service_types_with_http_info(self, **kwargs): def get_controller_services_from_controller(self, **kwargs): """ Gets controller services for 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. @@ -1573,7 +1573,7 @@ def get_controller_services_from_controller(self, **kwargs): def get_controller_services_from_controller_with_http_info(self, **kwargs): """ Gets controller services for 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. @@ -1646,7 +1646,7 @@ def get_controller_services_from_controller_with_http_info(self, **kwargs): def get_controller_services_from_group(self, id, **kwargs): """ Gets all controller services - + This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -1674,7 +1674,7 @@ def get_controller_services_from_group(self, id, **kwargs): def get_controller_services_from_group_with_http_info(self, id, **kwargs): """ Gets all controller services - + This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -1760,7 +1760,7 @@ def get_controller_services_from_group_with_http_info(self, id, **kwargs): def get_controller_status(self, **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. @@ -1785,7 +1785,7 @@ def get_controller_status(self, **kwargs): def get_controller_status_with_http_info(self, **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. @@ -1858,7 +1858,7 @@ def get_controller_status_with_http_info(self, **kwargs): def get_current_user(self, **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. @@ -1883,7 +1883,7 @@ def get_current_user(self, **kwargs): def get_current_user_with_http_info(self, **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. @@ -1956,7 +1956,7 @@ def get_current_user_with_http_info(self, **kwargs): def get_flow(self, 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. @@ -1982,7 +1982,7 @@ def get_flow(self, id, **kwargs): def get_flow_with_http_info(self, 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. @@ -2062,7 +2062,7 @@ def get_flow_with_http_info(self, id, **kwargs): def get_flow_config(self, **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. @@ -2087,7 +2087,7 @@ def get_flow_config(self, **kwargs): def get_flow_config_with_http_info(self, **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. @@ -2157,10 +2157,116 @@ def get_flow_config_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_flow_metrics(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str producer: The producer for flow file metrics. Each producer may have its own output format. (required) + :return: StreamingOutput + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_flow_metrics_with_http_info(producer, **kwargs) + else: + (data) = self.get_flow_metrics_with_http_info(producer, **kwargs) + return data + + def get_flow_metrics_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str producer: The producer for flow file metrics. Each producer may have its own output format. (required) + :return: StreamingOutput + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['producer'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_flow_metrics" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'producer' is set + if ('producer' not in params) or (params['producer'] is None): + raise ValueError("Missing the required parameter `producer` when calling `get_flow_metrics`") + + + collection_formats = {} + + path_params = {} + if 'producer' in params: + path_params['producer'] = params['producer'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['*/*']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/flow/metrics/{producer}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='StreamingOutput', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_flows(self, 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. @@ -2187,7 +2293,7 @@ def get_flows(self, registry_id, bucket_id, **kwargs): def get_flows_with_http_info(self, 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. @@ -2273,7 +2379,7 @@ def get_flows_with_http_info(self, registry_id, bucket_id, **kwargs): def get_input_port_status(self, 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. @@ -2301,7 +2407,7 @@ def get_input_port_status(self, id, **kwargs): def get_input_port_status_with_http_info(self, 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. @@ -2387,7 +2493,7 @@ def get_input_port_status_with_http_info(self, id, **kwargs): def get_output_port_status(self, 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. @@ -2415,7 +2521,7 @@ def get_output_port_status(self, id, **kwargs): def get_output_port_status_with_http_info(self, 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. @@ -2501,7 +2607,7 @@ def get_output_port_status_with_http_info(self, id, **kwargs): def get_parameter_contexts(self, **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. @@ -2526,7 +2632,7 @@ def get_parameter_contexts(self, **kwargs): def get_parameter_contexts_with_http_info(self, **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. @@ -2815,7 +2921,7 @@ def get_process_group_status_with_http_info(self, id, **kwargs): def get_process_group_status_history(self, 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. @@ -2841,7 +2947,7 @@ def get_process_group_status_history(self, id, **kwargs): def get_process_group_status_history_with_http_info(self, 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. @@ -2921,7 +3027,7 @@ def get_process_group_status_history_with_http_info(self, id, **kwargs): def get_processor_status(self, 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. @@ -2949,7 +3055,7 @@ def get_processor_status(self, id, **kwargs): def get_processor_status_with_http_info(self, 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. @@ -3035,7 +3141,7 @@ def get_processor_status_with_http_info(self, id, **kwargs): def get_processor_status_history(self, 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. @@ -3061,7 +3167,7 @@ def get_processor_status_history(self, id, **kwargs): def get_processor_status_history_with_http_info(self, 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. @@ -3252,7 +3358,7 @@ def get_processor_types_with_http_info(self, **kwargs): def get_registries(self, **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. @@ -3277,7 +3383,7 @@ def get_registries(self, **kwargs): def get_registries_with_http_info(self, **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. @@ -3350,7 +3456,7 @@ def get_registries_with_http_info(self, **kwargs): def get_remote_process_group_status(self, 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. @@ -3378,7 +3484,7 @@ def get_remote_process_group_status(self, id, **kwargs): def get_remote_process_group_status_with_http_info(self, 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. @@ -3464,7 +3570,7 @@ def get_remote_process_group_status_with_http_info(self, id, **kwargs): def get_remote_process_group_status_history(self, 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. @@ -3490,7 +3596,7 @@ def get_remote_process_group_status_history(self, id, **kwargs): def get_remote_process_group_status_history_with_http_info(self, 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. @@ -3681,7 +3787,7 @@ def get_reporting_task_types_with_http_info(self, **kwargs): def get_reporting_tasks(self, **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. @@ -3706,7 +3812,7 @@ def get_reporting_tasks(self, **kwargs): def get_reporting_tasks_with_http_info(self, **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. @@ -3779,7 +3885,7 @@ def get_reporting_tasks_with_http_info(self, **kwargs): def get_templates(self, **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. @@ -3804,7 +3910,7 @@ def get_templates(self, **kwargs): def get_templates_with_http_info(self, **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. @@ -3877,7 +3983,7 @@ def get_templates_with_http_info(self, **kwargs): def get_versions(self, 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. @@ -3905,7 +4011,7 @@ def get_versions(self, registry_id, bucket_id, flow_id, **kwargs): def get_versions_with_http_info(self, 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. @@ -4134,7 +4240,7 @@ def query_history_with_http_info(self, offset, count, **kwargs): def schedule_components(self, 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. @@ -4161,7 +4267,7 @@ def schedule_components(self, id, body, **kwargs): def schedule_components_with_http_info(self, 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. @@ -4365,6 +4471,7 @@ def search_flow(self, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str q: + :param str a: :return: SearchResultsEntity If the method is called asynchronously, returns the request thread. @@ -4391,12 +4498,13 @@ def search_flow_with_http_info(self, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str q: + :param str a: :return: SearchResultsEntity If the method is called asynchronously, returns the request thread. """ - all_params = ['q'] + all_params = ['q', 'a'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4420,6 +4528,8 @@ def search_flow_with_http_info(self, **kwargs): query_params = [] if 'q' in params: query_params.append(('q', params['q'])) + if 'a' in params: + query_params.append(('a', params['a'])) header_params = {} diff --git a/nipyapi/nifi/apis/flowfile_queues_api.py b/nipyapi/nifi/apis/flowfile_queues_api.py index 2e382535..67fd75a7 100644 --- a/nipyapi/nifi/apis/flowfile_queues_api.py +++ b/nipyapi/nifi/apis/flowfile_queues_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def create_drop_request(self, 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. @@ -69,7 +69,7 @@ def create_drop_request(self, id, **kwargs): def create_drop_request_with_http_info(self, 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. @@ -149,7 +149,7 @@ def create_drop_request_with_http_info(self, id, **kwargs): def create_flow_file_listing(self, 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. @@ -175,7 +175,7 @@ def create_flow_file_listing(self, id, **kwargs): def create_flow_file_listing_with_http_info(self, 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. @@ -255,7 +255,7 @@ def create_flow_file_listing_with_http_info(self, id, **kwargs): def delete_listing_request(self, 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. @@ -282,7 +282,7 @@ def delete_listing_request(self, id, listing_request_id, **kwargs): def delete_listing_request_with_http_info(self, 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. @@ -368,7 +368,7 @@ def delete_listing_request_with_http_info(self, id, listing_request_id, **kwargs def download_flow_file_content(self, 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. @@ -397,7 +397,7 @@ def download_flow_file_content(self, id, flowfile_uuid, **kwargs): def download_flow_file_content_with_http_info(self, 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. @@ -489,7 +489,7 @@ def download_flow_file_content_with_http_info(self, id, flowfile_uuid, **kwargs) def get_drop_request(self, 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. @@ -516,7 +516,7 @@ def get_drop_request(self, id, drop_request_id, **kwargs): def get_drop_request_with_http_info(self, 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. @@ -602,7 +602,7 @@ def get_drop_request_with_http_info(self, id, drop_request_id, **kwargs): def get_flow_file(self, 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. @@ -630,7 +630,7 @@ def get_flow_file(self, id, flowfile_uuid, **kwargs): def get_flow_file_with_http_info(self, 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. @@ -719,7 +719,7 @@ def get_flow_file_with_http_info(self, id, flowfile_uuid, **kwargs): def get_listing_request(self, 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. @@ -746,7 +746,7 @@ def get_listing_request(self, id, listing_request_id, **kwargs): def get_listing_request_with_http_info(self, 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. @@ -832,7 +832,7 @@ def get_listing_request_with_http_info(self, id, listing_request_id, **kwargs): def remove_drop_request(self, 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. @@ -859,7 +859,7 @@ def remove_drop_request(self, id, drop_request_id, **kwargs): def remove_drop_request_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/funnel_api.py b/nipyapi/nifi/apis/funnel_api.py index 07d98529..30f90bd4 100644 --- a/nipyapi/nifi/apis/funnel_api.py +++ b/nipyapi/nifi/apis/funnel_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_funnel(self, 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. @@ -69,7 +69,7 @@ def get_funnel(self, id, **kwargs): def get_funnel_with_http_info(self, 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. @@ -149,7 +149,7 @@ def get_funnel_with_http_info(self, id, **kwargs): def remove_funnel(self, 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. @@ -178,7 +178,7 @@ def remove_funnel(self, id, **kwargs): def remove_funnel_with_http_info(self, 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. @@ -267,7 +267,7 @@ def remove_funnel_with_http_info(self, id, **kwargs): def update_funnel(self, 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. @@ -294,7 +294,7 @@ def update_funnel(self, id, body, **kwargs): def update_funnel_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/input_ports_api.py b/nipyapi/nifi/apis/input_ports_api.py index f61a6030..1c289987 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_input_port(self, 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. @@ -69,7 +69,7 @@ def get_input_port(self, id, **kwargs): def get_input_port_with_http_info(self, 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. @@ -149,7 +149,7 @@ def get_input_port_with_http_info(self, id, **kwargs): def remove_input_port(self, 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. @@ -178,7 +178,7 @@ def remove_input_port(self, id, **kwargs): def remove_input_port_with_http_info(self, 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. @@ -267,7 +267,7 @@ def remove_input_port_with_http_info(self, id, **kwargs): def update_input_port(self, 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. @@ -294,7 +294,7 @@ def update_input_port(self, id, body, **kwargs): def update_input_port_with_http_info(self, 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. @@ -380,7 +380,7 @@ def update_input_port_with_http_info(self, id, body, **kwargs): def update_run_status(self, 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. @@ -407,7 +407,7 @@ def update_run_status(self, id, body, **kwargs): def update_run_status_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/labels_api.py b/nipyapi/nifi/apis/labels_api.py index e2628cdb..a24fd533 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_label(self, 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. @@ -69,7 +69,7 @@ def get_label(self, id, **kwargs): def get_label_with_http_info(self, 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. @@ -149,7 +149,7 @@ def get_label_with_http_info(self, id, **kwargs): def remove_label(self, 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. @@ -178,7 +178,7 @@ def remove_label(self, id, **kwargs): def remove_label_with_http_info(self, 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. @@ -267,7 +267,7 @@ def remove_label_with_http_info(self, id, **kwargs): def update_label(self, 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. @@ -294,7 +294,7 @@ def update_label(self, id, body, **kwargs): def update_label_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/output_ports_api.py b/nipyapi/nifi/apis/output_ports_api.py index 02feb723..d11b5de4 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_output_port(self, 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. @@ -69,7 +69,7 @@ def get_output_port(self, id, **kwargs): def get_output_port_with_http_info(self, 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. @@ -149,7 +149,7 @@ def get_output_port_with_http_info(self, id, **kwargs): def remove_output_port(self, 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. @@ -178,7 +178,7 @@ def remove_output_port(self, id, **kwargs): def remove_output_port_with_http_info(self, 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. @@ -267,7 +267,7 @@ def remove_output_port_with_http_info(self, id, **kwargs): def update_output_port(self, 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. @@ -294,7 +294,7 @@ def update_output_port(self, id, body, **kwargs): def update_output_port_with_http_info(self, 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. @@ -380,7 +380,7 @@ def update_output_port_with_http_info(self, id, body, **kwargs): def update_run_status(self, 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. @@ -407,7 +407,7 @@ def update_run_status(self, id, body, **kwargs): def update_run_status_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/parameter_contexts_api.py b/nipyapi/nifi/apis/parameter_contexts_api.py index 09f668ca..e8cc4eb6 100644 --- a/nipyapi/nifi/apis/parameter_contexts_api.py +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def create_parameter_context(self, 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. @@ -69,7 +69,7 @@ def create_parameter_context(self, body, **kwargs): def create_parameter_context_with_http_info(self, 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. @@ -607,7 +607,7 @@ def get_parameter_context_with_http_info(self, id, **kwargs): def get_parameter_context_update(self, 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. + 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. @@ -634,7 +634,7 @@ def get_parameter_context_update(self, context_id, request_id, **kwargs): def get_parameter_context_update_with_http_info(self, 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. + 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. @@ -720,7 +720,7 @@ def get_parameter_context_update_with_http_info(self, context_id, request_id, ** def get_validation_request(self, 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. + 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. @@ -747,7 +747,7 @@ def get_validation_request(self, context_id, id, **kwargs): def get_validation_request_with_http_info(self, 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. + 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. diff --git a/nipyapi/nifi/apis/policies_api.py b/nipyapi/nifi/apis/policies_api.py index ca22ca37..e2199282 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def create_access_policy(self, 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. @@ -69,7 +69,7 @@ def create_access_policy(self, body, **kwargs): def create_access_policy_with_http_info(self, 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. @@ -149,7 +149,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): def get_access_policy(self, 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. @@ -175,7 +175,7 @@ def get_access_policy(self, id, **kwargs): def get_access_policy_with_http_info(self, 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. @@ -370,7 +370,7 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar def remove_access_policy(self, 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. @@ -399,7 +399,7 @@ def remove_access_policy(self, id, **kwargs): def remove_access_policy_with_http_info(self, 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. @@ -488,7 +488,7 @@ def remove_access_policy_with_http_info(self, id, **kwargs): def update_access_policy(self, 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. @@ -515,7 +515,7 @@ def update_access_policy(self, id, body, **kwargs): def update_access_policy_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/process_groups_api.py b/nipyapi/nifi/apis/process_groups_api.py index 6d244748..4c234029 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def copy_snippet(self, 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. @@ -70,7 +70,7 @@ def copy_snippet(self, id, body, **kwargs): def copy_snippet_with_http_info(self, 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. @@ -156,7 +156,7 @@ def copy_snippet_with_http_info(self, id, body, **kwargs): def create_connection(self, 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. @@ -183,7 +183,7 @@ def create_connection(self, id, body, **kwargs): def create_connection_with_http_info(self, 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. @@ -269,7 +269,7 @@ def create_connection_with_http_info(self, id, body, **kwargs): def create_controller_service(self, 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. @@ -296,7 +296,7 @@ def create_controller_service(self, id, body, **kwargs): def create_controller_service_with_http_info(self, 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. @@ -379,10 +379,116 @@ def create_controller_service_with_http_info(self, id, body, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def create_empty_all_connections_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: ProcessGroupEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.create_empty_all_connections_request_with_http_info(id, **kwargs) + else: + (data) = self.create_empty_all_connections_request_with_http_info(id, **kwargs) + return data + + def create_empty_all_connections_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: ProcessGroupEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_empty_all_connections_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `create_empty_all_connections_request`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/process-groups/{id}/empty-all-connections-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessGroupEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def create_funnel(self, 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. @@ -409,7 +515,7 @@ def create_funnel(self, id, body, **kwargs): def create_funnel_with_http_info(self, 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. @@ -495,7 +601,7 @@ def create_funnel_with_http_info(self, id, body, **kwargs): def create_input_port(self, 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. @@ -522,7 +628,7 @@ def create_input_port(self, id, body, **kwargs): def create_input_port_with_http_info(self, 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. @@ -608,7 +714,7 @@ def create_input_port_with_http_info(self, id, body, **kwargs): def create_label(self, 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. @@ -635,7 +741,7 @@ def create_label(self, id, body, **kwargs): def create_label_with_http_info(self, 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. @@ -721,7 +827,7 @@ def create_label_with_http_info(self, id, body, **kwargs): def create_output_port(self, 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. @@ -748,7 +854,7 @@ def create_output_port(self, id, body, **kwargs): def create_output_port_with_http_info(self, 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. @@ -834,7 +940,7 @@ def create_output_port_with_http_info(self, id, body, **kwargs): def create_process_group(self, 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. @@ -861,7 +967,7 @@ def create_process_group(self, id, body, **kwargs): def create_process_group_with_http_info(self, 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. @@ -947,7 +1053,7 @@ def create_process_group_with_http_info(self, id, body, **kwargs): def create_processor(self, 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. @@ -974,7 +1080,7 @@ def create_processor(self, id, body, **kwargs): def create_processor_with_http_info(self, 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. @@ -1060,7 +1166,7 @@ def create_processor_with_http_info(self, id, body, **kwargs): def create_remote_process_group(self, 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. @@ -1087,7 +1193,7 @@ def create_remote_process_group(self, id, body, **kwargs): def create_remote_process_group_with_http_info(self, 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. @@ -1173,7 +1279,7 @@ def create_remote_process_group_with_http_info(self, id, body, **kwargs): def create_template(self, 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. @@ -1200,7 +1306,7 @@ def create_template(self, id, body, **kwargs): def create_template_with_http_info(self, 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. @@ -1283,6 +1389,116 @@ def create_template_with_http_info(self, id, body, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def delete_replace_process_group_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ProcessGroupReplaceRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.delete_replace_process_group_request_with_http_info(id, **kwargs) + else: + (data) = self.delete_replace_process_group_request_with_http_info(id, **kwargs) + return data + + def delete_replace_process_group_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Update Request (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :return: ProcessGroupReplaceRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'disconnected_node_acknowledged'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_replace_process_group_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `delete_replace_process_group_request`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + if 'disconnected_node_acknowledged' in params: + query_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/process-groups/replace-requests/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessGroupReplaceRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def delete_variable_registry_update_request(self, 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. @@ -1403,7 +1619,7 @@ def delete_variable_registry_update_request_with_http_info(self, group_id, updat def export_process_group(self, 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. @@ -1429,7 +1645,7 @@ def export_process_group(self, id, **kwargs): def export_process_group_with_http_info(self, 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. @@ -1509,7 +1725,7 @@ def export_process_group_with_http_info(self, id, **kwargs): def get_connections(self, 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. @@ -1535,7 +1751,7 @@ def get_connections(self, id, **kwargs): def get_connections_with_http_info(self, 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. @@ -1612,53 +1828,55 @@ def get_connections_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_funnels(self, id, **kwargs): + def get_drop_all_flowfiles_request(self, id, drop_request_id, **kwargs): """ - Gets all funnels - + 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_funnels(id, callback=callback_function) + >>> thread = api.get_drop_all_flowfiles_request(id, drop_request_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str id: The process group id. (required) - :return: FunnelsEntity + :param str drop_request_id: The drop request id. (required) + :return: DropRequestEntity If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_funnels_with_http_info(id, **kwargs) + return self.get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, **kwargs) else: - (data) = self.get_funnels_with_http_info(id, **kwargs) + (data) = self.get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, **kwargs) return data - def get_funnels_with_http_info(self, id, **kwargs): + def get_drop_all_flowfiles_request_with_http_info(self, id, drop_request_id, **kwargs): """ - Gets all funnels - + 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_funnels_with_http_info(id, callback=callback_function) + >>> thread = api.get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str id: The process group id. (required) - :return: FunnelsEntity + :param str drop_request_id: The drop request id. (required) + :return: DropRequestEntity If the method is called asynchronously, returns the request thread. """ - all_params = ['id'] + all_params = ['id', 'drop_request_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -1669,13 +1887,16 @@ def get_funnels_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_funnels" % key + " to method get_drop_all_flowfiles_request" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_funnels`") + raise ValueError("Missing the required parameter `id` when calling `get_drop_all_flowfiles_request`") + # verify the required parameter 'drop_request_id' is set + if ('drop_request_id' not in params) or (params['drop_request_id'] is None): + raise ValueError("Missing the required parameter `drop_request_id` when calling `get_drop_all_flowfiles_request`") collection_formats = {} @@ -1683,6 +1904,8 @@ def get_funnels_with_http_info(self, id, **kwargs): path_params = {} if 'id' in params: path_params['id'] = params['id'] + if 'drop_request_id' in params: + path_params['drop-request-id'] = params['drop_request_id'] query_params = [] @@ -1703,14 +1926,14 @@ def get_funnels_with_http_info(self, id, **kwargs): # Authentication setting auth_settings = ['tokenAuth', 'basicAuth'] - return self.api_client.call_api('/process-groups/{id}/funnels', 'GET', + return self.api_client.call_api('/process-groups/{id}/empty-all-connections-requests/{drop-request-id}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='FunnelsEntity', + response_type='DropRequestEntity', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1718,48 +1941,48 @@ def get_funnels_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def get_input_ports(self, id, **kwargs): + def get_funnels(self, id, **kwargs): """ - Gets all input ports - + 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_input_ports(id, callback=callback_function) + >>> thread = api.get_funnels(id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str id: The process group id. (required) - :return: InputPortsEntity + :return: FunnelsEntity If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.get_input_ports_with_http_info(id, **kwargs) + return self.get_funnels_with_http_info(id, **kwargs) else: - (data) = self.get_input_ports_with_http_info(id, **kwargs) + (data) = self.get_funnels_with_http_info(id, **kwargs) return data - def get_input_ports_with_http_info(self, id, **kwargs): + def get_funnels_with_http_info(self, id, **kwargs): """ - Gets all input ports - + 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_input_ports_with_http_info(id, callback=callback_function) + >>> thread = api.get_funnels_with_http_info(id, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str id: The process group id. (required) - :return: InputPortsEntity + :return: FunnelsEntity If the method is called asynchronously, returns the request thread. """ @@ -1775,13 +1998,13 @@ def get_input_ports_with_http_info(self, id, **kwargs): if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method get_input_ports" % key + " to method get_funnels" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_input_ports`") + raise ValueError("Missing the required parameter `id` when calling `get_funnels`") collection_formats = {} @@ -1809,7 +2032,113 @@ def get_input_ports_with_http_info(self, id, **kwargs): # Authentication setting auth_settings = ['tokenAuth', 'basicAuth'] - return self.api_client.call_api('/process-groups/{id}/input-ports', 'GET', + return self.api_client.call_api('/process-groups/{id}/funnels', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FunnelsEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_input_ports(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: InputPortsEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_input_ports_with_http_info(id, **kwargs) + else: + (data) = self.get_input_ports_with_http_info(id, **kwargs) + return data + + def get_input_ports_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :return: InputPortsEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_input_ports" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_input_ports`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/process-groups/{id}/input-ports', 'GET', path_params, query_params, header_params, @@ -1827,7 +2156,7 @@ def get_input_ports_with_http_info(self, id, **kwargs): def get_labels(self, 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. @@ -1853,7 +2182,7 @@ def get_labels(self, id, **kwargs): def get_labels_with_http_info(self, 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. @@ -1933,7 +2262,7 @@ def get_labels_with_http_info(self, id, **kwargs): def get_local_modifications(self, 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. @@ -1959,7 +2288,7 @@ def get_local_modifications(self, id, **kwargs): def get_local_modifications_with_http_info(self, 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. @@ -2039,7 +2368,7 @@ def get_local_modifications_with_http_info(self, id, **kwargs): def get_output_ports(self, 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. @@ -2065,7 +2394,7 @@ def get_output_ports(self, id, **kwargs): def get_output_ports_with_http_info(self, 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. @@ -2145,7 +2474,7 @@ def get_output_ports_with_http_info(self, id, **kwargs): def get_process_group(self, 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. @@ -2171,7 +2500,7 @@ def get_process_group(self, id, **kwargs): def get_process_group_with_http_info(self, 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. @@ -2251,7 +2580,7 @@ def get_process_group_with_http_info(self, id, **kwargs): def get_process_groups(self, 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. @@ -2277,7 +2606,7 @@ def get_process_groups(self, id, **kwargs): def get_process_groups_with_http_info(self, 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. @@ -2357,7 +2686,7 @@ def get_process_groups_with_http_info(self, id, **kwargs): def get_processors(self, 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. @@ -2384,7 +2713,7 @@ def get_processors(self, id, **kwargs): def get_processors_with_http_info(self, 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. @@ -2467,7 +2796,7 @@ def get_processors_with_http_info(self, id, **kwargs): def get_remote_process_groups(self, 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. @@ -2493,7 +2822,7 @@ def get_remote_process_groups(self, id, **kwargs): def get_remote_process_groups_with_http_info(self, 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. @@ -2570,6 +2899,112 @@ def get_remote_process_groups_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_replace_process_group_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Replace Request (required) + :return: ProcessGroupReplaceRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_replace_process_group_request_with_http_info(id, **kwargs) + else: + (data) = self.get_replace_process_group_request_with_http_info(id, **kwargs) + return data + + def get_replace_process_group_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The ID of the Replace Request (required) + :return: ProcessGroupReplaceRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_replace_process_group_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_replace_process_group_request`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/process-groups/replace-requests/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessGroupReplaceRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_variable_registry(self, id, **kwargs): """ Gets a process group's variable registry @@ -2796,7 +3231,7 @@ def get_variable_registry_update_request_with_http_info(self, group_id, update_i def import_template(self, 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. @@ -2822,7 +3257,7 @@ def import_template(self, id, **kwargs): def import_template_with_http_info(self, 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. @@ -2899,10 +3334,123 @@ def import_template_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def initiate_replace_process_group(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :param ProcessGroupImportEntity body: The process group replace request entity (required) + :return: ProcessGroupReplaceRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.initiate_replace_process_group_with_http_info(id, body, **kwargs) + else: + (data) = self.initiate_replace_process_group_with_http_info(id, body, **kwargs) + return data + + def initiate_replace_process_group_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :param ProcessGroupImportEntity body: The process group replace request entity (required) + :return: ProcessGroupReplaceRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method initiate_replace_process_group" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `initiate_replace_process_group`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `initiate_replace_process_group`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/process-groups/{id}/replace-requests', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessGroupReplaceRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def instantiate_template(self, 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. @@ -2929,7 +3477,7 @@ def instantiate_template(self, id, body, **kwargs): def instantiate_template_with_http_info(self, 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. @@ -3012,10 +3560,123 @@ def instantiate_template_with_http_info(self, id, body, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def remove_drop_request(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :param str drop_request_id: The drop request id. (required) + :return: DropRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.remove_drop_request_with_http_info(id, drop_request_id, **kwargs) + else: + (data) = self.remove_drop_request_with_http_info(id, drop_request_id, **kwargs) + return data + + def remove_drop_request_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :param str drop_request_id: The drop request id. (required) + :return: DropRequestEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'drop_request_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_drop_request" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `remove_drop_request`") + # verify the required parameter 'drop_request_id' is set + if ('drop_request_id' not in params) or (params['drop_request_id'] is None): + raise ValueError("Missing the required parameter `drop_request_id` when calling `remove_drop_request`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + if 'drop_request_id' in params: + path_params['drop-request-id'] = params['drop_request_id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/process-groups/{id}/empty-all-connections-requests/{drop-request-id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='DropRequestEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def remove_process_group(self, 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. @@ -3044,7 +3705,7 @@ def remove_process_group(self, id, **kwargs): def remove_process_group_with_http_info(self, 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. @@ -3130,6 +3791,119 @@ def remove_process_group_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def replace_process_group(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :param ProcessGroupImportEntity body: The process group replace request entity. (required) + :return: ProcessGroupImportEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.replace_process_group_with_http_info(id, body, **kwargs) + else: + (data) = self.replace_process_group_with_http_info(id, body, **kwargs) + return data + + def replace_process_group_with_http_info(self, 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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str id: The process group id. (required) + :param ProcessGroupImportEntity body: The process group replace request entity. (required) + :return: ProcessGroupImportEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method replace_process_group" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params) or (params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `replace_process_group`") + # verify the required parameter 'body' is set + if ('body' not in params) or (params['body'] is None): + raise ValueError("Missing the required parameter `body` when calling `replace_process_group`") + + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/process-groups/{id}/flow-contents', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessGroupImportEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def submit_update_variable_registry_request(self, id, body, **kwargs): """ Submits a request to update a process group's variable registry @@ -3246,7 +4020,7 @@ def submit_update_variable_registry_request_with_http_info(self, id, body, **kwa def update_process_group(self, 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. @@ -3273,7 +4047,7 @@ def update_process_group(self, id, body, **kwargs): def update_process_group_with_http_info(self, 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. @@ -3472,7 +4246,7 @@ def update_variable_registry_with_http_info(self, id, body, **kwargs): def upload_template(self, 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. @@ -3500,7 +4274,7 @@ def upload_template(self, id, template, **kwargs): def upload_template_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/processors_api.py b/nipyapi/nifi/apis/processors_api.py index 23151ae7..1a381cff 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def clear_state(self, 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. @@ -69,7 +69,7 @@ def clear_state(self, id, **kwargs): def clear_state_with_http_info(self, 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. @@ -149,7 +149,7 @@ def clear_state_with_http_info(self, id, **kwargs): def delete_processor(self, 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. @@ -178,7 +178,7 @@ def delete_processor(self, id, **kwargs): def delete_processor_with_http_info(self, 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. @@ -267,7 +267,7 @@ def delete_processor_with_http_info(self, id, **kwargs): def get_processor(self, 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. @@ -293,7 +293,7 @@ def get_processor(self, id, **kwargs): def get_processor_with_http_info(self, 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. @@ -476,10 +476,113 @@ def get_processor_diagnostics_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_processor_run_status_details(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param RunStatusDetailsRequestEntity body: The request for the processors that should be included in the results + :return: ProcessorsRunStatusDetailsEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_processor_run_status_details_with_http_info(**kwargs) + else: + (data) = self.get_processor_run_status_details_with_http_info(**kwargs) + return data + + def get_processor_run_status_details_with_http_info(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :param RunStatusDetailsRequestEntity body: The request for the processors that should be included in the results + :return: ProcessorsRunStatusDetailsEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_processor_run_status_details" % key + ) + params[key] = val + del params['kwargs'] + + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['application/json']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/processors/run-status-details/queries', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='ProcessorsRunStatusDetailsEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_property_descriptor(self, 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. @@ -507,7 +610,7 @@ def get_property_descriptor(self, id, property_name, **kwargs): def get_property_descriptor_with_http_info(self, 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. @@ -596,7 +699,7 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): def get_state(self, 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. @@ -622,7 +725,7 @@ def get_state(self, id, **kwargs): def get_state_with_http_info(self, 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. @@ -702,7 +805,7 @@ def get_state_with_http_info(self, id, **kwargs): def terminate_processor(self, 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. @@ -728,7 +831,7 @@ def terminate_processor(self, id, **kwargs): def terminate_processor_with_http_info(self, 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. @@ -808,7 +911,7 @@ def terminate_processor_with_http_info(self, id, **kwargs): def update_processor(self, 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. @@ -835,7 +938,7 @@ def update_processor(self, id, body, **kwargs): def update_processor_with_http_info(self, 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. @@ -921,7 +1024,7 @@ def update_processor_with_http_info(self, id, body, **kwargs): def update_run_status(self, 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. @@ -948,7 +1051,7 @@ def update_run_status(self, id, body, **kwargs): def update_run_status_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index b78219e3..69b01868 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def delete_lineage(self, 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. @@ -70,7 +70,7 @@ def delete_lineage(self, id, **kwargs): def delete_lineage_with_http_info(self, 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. @@ -153,7 +153,7 @@ def delete_lineage_with_http_info(self, id, **kwargs): def delete_provenance(self, 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. @@ -180,7 +180,7 @@ def delete_provenance(self, id, **kwargs): def delete_provenance_with_http_info(self, 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. @@ -263,7 +263,7 @@ def delete_provenance_with_http_info(self, id, **kwargs): def get_lineage(self, 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. @@ -290,7 +290,7 @@ def get_lineage(self, id, **kwargs): def get_lineage_with_http_info(self, 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. @@ -373,7 +373,7 @@ def get_lineage_with_http_info(self, id, **kwargs): def get_provenance(self, 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. @@ -402,7 +402,7 @@ def get_provenance(self, id, **kwargs): def get_provenance_with_http_info(self, 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. @@ -491,7 +491,7 @@ def get_provenance_with_http_info(self, id, **kwargs): def get_search_options(self, **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. @@ -516,7 +516,7 @@ def get_search_options(self, **kwargs): def get_search_options_with_http_info(self, **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. diff --git a/nipyapi/nifi/apis/provenance_events_api.py b/nipyapi/nifi/apis/provenance_events_api.py index 836fe8ce..0ae04854 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_input_content(self, 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. @@ -70,7 +70,7 @@ def get_input_content(self, id, **kwargs): def get_input_content_with_http_info(self, 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. @@ -153,7 +153,7 @@ def get_input_content_with_http_info(self, id, **kwargs): def get_output_content(self, 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. @@ -180,7 +180,7 @@ def get_output_content(self, id, **kwargs): def get_output_content_with_http_info(self, 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. @@ -263,7 +263,7 @@ def get_output_content_with_http_info(self, id, **kwargs): def get_provenance_event(self, 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. @@ -290,7 +290,7 @@ def get_provenance_event(self, id, **kwargs): def get_provenance_event_with_http_info(self, 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. @@ -373,7 +373,7 @@ def get_provenance_event_with_http_info(self, id, **kwargs): def submit_replay(self, 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. @@ -399,7 +399,7 @@ def submit_replay(self, body, **kwargs): def submit_replay_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/remote_process_groups_api.py b/nipyapi/nifi/apis/remote_process_groups_api.py index c516db4d..efd60620 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_remote_process_group(self, 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. @@ -69,7 +69,7 @@ def get_remote_process_group(self, id, **kwargs): def get_remote_process_group_with_http_info(self, 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. @@ -149,7 +149,7 @@ def get_remote_process_group_with_http_info(self, id, **kwargs): def get_state(self, 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. @@ -175,7 +175,7 @@ def get_state(self, id, **kwargs): def get_state_with_http_info(self, 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. @@ -255,7 +255,7 @@ def get_state_with_http_info(self, id, **kwargs): def remove_remote_process_group(self, 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. @@ -284,7 +284,7 @@ def remove_remote_process_group(self, id, **kwargs): def remove_remote_process_group_with_http_info(self, 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. @@ -373,7 +373,7 @@ def remove_remote_process_group_with_http_info(self, id, **kwargs): def update_remote_process_group(self, 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. @@ -400,7 +400,7 @@ def update_remote_process_group(self, id, body, **kwargs): def update_remote_process_group_with_http_info(self, 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. @@ -966,7 +966,7 @@ def update_remote_process_group_output_port_run_status_with_http_info(self, id, def update_remote_process_group_run_status(self, 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. @@ -993,7 +993,7 @@ def update_remote_process_group_run_status(self, id, body, **kwargs): def update_remote_process_group_run_status_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/reporting_tasks_api.py b/nipyapi/nifi/apis/reporting_tasks_api.py index 6e18acc5..6ecf8fbd 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def clear_state(self, 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. @@ -69,7 +69,7 @@ def clear_state(self, id, **kwargs): def clear_state_with_http_info(self, 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. @@ -149,7 +149,7 @@ def clear_state_with_http_info(self, id, **kwargs): def get_property_descriptor(self, 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. @@ -176,7 +176,7 @@ def get_property_descriptor(self, id, property_name, **kwargs): def get_property_descriptor_with_http_info(self, 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. @@ -262,7 +262,7 @@ def get_property_descriptor_with_http_info(self, id, property_name, **kwargs): def get_reporting_task(self, 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. @@ -288,7 +288,7 @@ def get_reporting_task(self, id, **kwargs): def get_reporting_task_with_http_info(self, 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. @@ -368,7 +368,7 @@ def get_reporting_task_with_http_info(self, id, **kwargs): def get_state(self, 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. @@ -394,7 +394,7 @@ def get_state(self, id, **kwargs): def get_state_with_http_info(self, 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. @@ -474,7 +474,7 @@ def get_state_with_http_info(self, id, **kwargs): def remove_reporting_task(self, 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. @@ -503,7 +503,7 @@ def remove_reporting_task(self, id, **kwargs): def remove_reporting_task_with_http_info(self, 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. @@ -592,7 +592,7 @@ def remove_reporting_task_with_http_info(self, id, **kwargs): def update_reporting_task(self, 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. @@ -619,7 +619,7 @@ def update_reporting_task(self, id, body, **kwargs): def update_reporting_task_with_http_info(self, 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. @@ -705,7 +705,7 @@ def update_reporting_task_with_http_info(self, id, body, **kwargs): def update_run_status(self, 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. @@ -732,7 +732,7 @@ def update_run_status(self, id, body, **kwargs): def update_run_status_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/resources_api.py b/nipyapi/nifi/apis/resources_api.py index 8c52dd59..cbae1f87 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_resources(self, **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. @@ -68,7 +68,7 @@ def get_resources(self, **kwargs): def get_resources_with_http_info(self, **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. diff --git a/nipyapi/nifi/apis/site_to_site_api.py b/nipyapi/nifi/apis/site_to_site_api.py index 564c21da..25113b24 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_peers(self, **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. @@ -68,7 +68,7 @@ def get_peers(self, **kwargs): def get_peers_with_http_info(self, **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. @@ -141,7 +141,7 @@ def get_peers_with_http_info(self, **kwargs): def get_site_to_site_details(self, **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. @@ -166,7 +166,7 @@ def get_site_to_site_details(self, **kwargs): def get_site_to_site_details_with_http_info(self, **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. diff --git a/nipyapi/nifi/apis/snippets_api.py b/nipyapi/nifi/apis/snippets_api.py index 003dc3e1..67f7f185 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def create_snippet(self, 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. @@ -69,7 +69,7 @@ def create_snippet(self, body, **kwargs): def create_snippet_with_http_info(self, 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. @@ -149,7 +149,7 @@ def create_snippet_with_http_info(self, body, **kwargs): def delete_snippet(self, 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. @@ -176,7 +176,7 @@ def delete_snippet(self, id, **kwargs): def delete_snippet_with_http_info(self, 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. @@ -259,7 +259,7 @@ def delete_snippet_with_http_info(self, id, **kwargs): def update_snippet(self, 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. @@ -286,7 +286,7 @@ def update_snippet(self, id, body, **kwargs): def update_snippet_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/system_diagnostics_api.py b/nipyapi/nifi/apis/system_diagnostics_api.py index 1b4ffc17..5ed6ccae 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def get_system_diagnostics(self, **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. @@ -70,7 +70,7 @@ def get_system_diagnostics(self, **kwargs): def get_system_diagnostics_with_http_info(self, **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. diff --git a/nipyapi/nifi/apis/templates_api.py b/nipyapi/nifi/apis/templates_api.py index 637ac4dc..94401bd2 100644 --- a/nipyapi/nifi/apis/templates_api.py +++ b/nipyapi/nifi/apis/templates_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,7 +43,7 @@ def __init__(self, api_client=None): def export_template(self, 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. @@ -69,7 +69,7 @@ def export_template(self, id, **kwargs): def export_template_with_http_info(self, 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. @@ -149,7 +149,7 @@ def export_template_with_http_info(self, id, **kwargs): def remove_template(self, 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. @@ -176,7 +176,7 @@ def remove_template(self, id, **kwargs): def remove_template_with_http_info(self, 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. diff --git a/nipyapi/nifi/apis/tenants_api.py b/nipyapi/nifi/apis/tenants_api.py index 9d52f8b1..c6e201a7 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/versions_api.py b/nipyapi/nifi/apis/versions_api.py index e74a76c6..6b9cc9f4 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -479,7 +479,7 @@ def delete_version_control_request_with_http_info(self, id, **kwargs): def export_flow_version(self, 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. @@ -505,7 +505,7 @@ def export_flow_version(self, id, **kwargs): def export_flow_version_with_http_info(self, 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. diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 51ab46cd..643995b4 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -52,8 +52,8 @@ def __init__(self): self.temp_folder_path = None # Authentication Settings - # Auth types to enable, use tokenAuth or basicAuth - self.enabled_auth = ['tokenAuth'] + # Auth types to enable + self.enabled_auth = ['tokenAuth', 'basicAuth'] # dict to store API key(s) self.api_key = {} # dict to store API prefix (e.g. Bearer) @@ -241,6 +241,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.11.1-SNAPSHOT\n"\ + "Version of the API: 1.12.1\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/nifi/models/__init__.py b/nipyapi/nifi/models/__init__.py index bc53ae32..facde827 100644 --- a/nipyapi/nifi/models/__init__.py +++ b/nipyapi/nifi/models/__init__.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -187,7 +187,10 @@ from .process_group_entity import ProcessGroupEntity from .process_group_flow_dto import ProcessGroupFlowDTO from .process_group_flow_entity import ProcessGroupFlowEntity +from .process_group_import_entity import ProcessGroupImportEntity from .process_group_name_dto import ProcessGroupNameDTO +from .process_group_replace_request_dto import ProcessGroupReplaceRequestDTO +from .process_group_replace_request_entity import ProcessGroupReplaceRequestEntity from .process_group_status_dto import ProcessGroupStatusDTO from .process_group_status_entity import ProcessGroupStatusEntity from .process_group_status_snapshot_dto import ProcessGroupStatusSnapshotDTO @@ -196,6 +199,8 @@ from .processor_config_dto import ProcessorConfigDTO from .processor_dto import ProcessorDTO from .processor_entity import ProcessorEntity +from .processor_run_status_details_dto import ProcessorRunStatusDetailsDTO +from .processor_run_status_details_entity import ProcessorRunStatusDetailsEntity from .processor_run_status_entity import ProcessorRunStatusEntity from .processor_status_dto import ProcessorStatusDTO from .processor_status_entity import ProcessorStatusEntity @@ -203,6 +208,7 @@ from .processor_status_snapshot_entity import ProcessorStatusSnapshotEntity from .processor_types_entity import ProcessorTypesEntity from .processors_entity import ProcessorsEntity +from .processors_run_status_details_entity import ProcessorsRunStatusDetailsEntity from .property_descriptor_dto import PropertyDescriptorDTO from .property_descriptor_entity import PropertyDescriptorEntity from .property_history_dto import PropertyHistoryDTO @@ -243,6 +249,8 @@ from .resource_dto import ResourceDTO from .resources_entity import ResourcesEntity from .revision_dto import RevisionDTO +from .revision_info import RevisionInfo +from .run_status_details_request_entity import RunStatusDetailsRequestEntity from .schedule_components_entity import ScheduleComponentsEntity from .search_result_group_dto import SearchResultGroupDTO from .search_results_dto import SearchResultsDTO diff --git a/nipyapi/nifi/models/about_dto.py b/nipyapi/nifi/models/about_dto.py index 506f3f39..56abd7d9 100644 --- a/nipyapi/nifi/models/about_dto.py +++ b/nipyapi/nifi/models/about_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/about_entity.py b/nipyapi/nifi/models/about_entity.py index 0059fd1a..3b08aab1 100644 --- a/nipyapi/nifi/models/about_entity.py +++ b/nipyapi/nifi/models/about_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_dto.py b/nipyapi/nifi/models/access_configuration_dto.py index d3cbd518..8cbce773 100644 --- a/nipyapi/nifi/models/access_configuration_dto.py +++ b/nipyapi/nifi/models/access_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_entity.py b/nipyapi/nifi/models/access_configuration_entity.py index 9ed89777..21b7d450 100644 --- a/nipyapi/nifi/models/access_configuration_entity.py +++ b/nipyapi/nifi/models/access_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_dto.py b/nipyapi/nifi/models/access_policy_dto.py index 44428c47..df76c032 100644 --- a/nipyapi/nifi/models/access_policy_dto.py +++ b/nipyapi/nifi/models/access_policy_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_entity.py b/nipyapi/nifi/models/access_policy_entity.py index 7d22df11..cebadf77 100644 --- a/nipyapi/nifi/models/access_policy_entity.py +++ b/nipyapi/nifi/models/access_policy_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_dto.py b/nipyapi/nifi/models/access_policy_summary_dto.py index 242e4696..2aa2880a 100644 --- a/nipyapi/nifi/models/access_policy_summary_dto.py +++ b/nipyapi/nifi/models/access_policy_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_entity.py b/nipyapi/nifi/models/access_policy_summary_entity.py index b8e89862..5f78d35a 100644 --- a/nipyapi/nifi/models/access_policy_summary_entity.py +++ b/nipyapi/nifi/models/access_policy_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_dto.py b/nipyapi/nifi/models/access_status_dto.py index 70e4db66..0a10585d 100644 --- a/nipyapi/nifi/models/access_status_dto.py +++ b/nipyapi/nifi/models/access_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_entity.py b/nipyapi/nifi/models/access_status_entity.py index f4b7e6ae..393767fe 100644 --- a/nipyapi/nifi/models/access_status_entity.py +++ b/nipyapi/nifi/models/access_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_details_dto.py b/nipyapi/nifi/models/action_details_dto.py index 97cee28a..096b1679 100644 --- a/nipyapi/nifi/models/action_details_dto.py +++ b/nipyapi/nifi/models/action_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,11 +31,11 @@ class ActionDetailsDTO(object): and the value is json key in definition. """ swagger_types = { - + } attribute_map = { - + } def __init__(self): diff --git a/nipyapi/nifi/models/action_dto.py b/nipyapi/nifi/models/action_dto.py index a7155d85..3564e2b8 100644 --- a/nipyapi/nifi/models/action_dto.py +++ b/nipyapi/nifi/models/action_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_entity.py b/nipyapi/nifi/models/action_entity.py index b60e755c..1122689f 100644 --- a/nipyapi/nifi/models/action_entity.py +++ b/nipyapi/nifi/models/action_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/activate_controller_services_entity.py b/nipyapi/nifi/models/activate_controller_services_entity.py index a987976a..21d12b26 100644 --- a/nipyapi/nifi/models/activate_controller_services_entity.py +++ b/nipyapi/nifi/models/activate_controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_dto.py b/nipyapi/nifi/models/affected_component_dto.py index d5e21930..55c8508a 100644 --- a/nipyapi/nifi/models/affected_component_dto.py +++ b/nipyapi/nifi/models/affected_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_entity.py b/nipyapi/nifi/models/affected_component_entity.py index 213556ec..be102951 100644 --- a/nipyapi/nifi/models/affected_component_entity.py +++ b/nipyapi/nifi/models/affected_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_dto.py b/nipyapi/nifi/models/allowable_value_dto.py index 2ab2d7ce..42723939 100644 --- a/nipyapi/nifi/models/allowable_value_dto.py +++ b/nipyapi/nifi/models/allowable_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_entity.py b/nipyapi/nifi/models/allowable_value_entity.py index 9f8decd1..b9637794 100644 --- a/nipyapi/nifi/models/allowable_value_entity.py +++ b/nipyapi/nifi/models/allowable_value_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/attribute_dto.py b/nipyapi/nifi/models/attribute_dto.py index b8113672..3b18ad5d 100644 --- a/nipyapi/nifi/models/attribute_dto.py +++ b/nipyapi/nifi/models/attribute_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_dto.py b/nipyapi/nifi/models/banner_dto.py index 18f30355..b00156cc 100644 --- a/nipyapi/nifi/models/banner_dto.py +++ b/nipyapi/nifi/models/banner_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_entity.py b/nipyapi/nifi/models/banner_entity.py index 00121dc0..e1fee090 100644 --- a/nipyapi/nifi/models/banner_entity.py +++ b/nipyapi/nifi/models/banner_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_settings_dto.py b/nipyapi/nifi/models/batch_settings_dto.py index 96301d3f..5bfdf0ae 100644 --- a/nipyapi/nifi/models/batch_settings_dto.py +++ b/nipyapi/nifi/models/batch_settings_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_size.py b/nipyapi/nifi/models/batch_size.py index a41dd157..9c6d6c8b 100644 --- a/nipyapi/nifi/models/batch_size.py +++ b/nipyapi/nifi/models/batch_size.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket.py b/nipyapi/nifi/models/bucket.py index bb89a549..b06473e5 100644 --- a/nipyapi/nifi/models/bucket.py +++ b/nipyapi/nifi/models/bucket.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,8 @@ class Bucket(object): 'description': 'str', 'allow_bundle_redeploy': 'bool', 'allow_public_read': 'bool', - 'permissions': 'Permissions' + 'permissions': 'Permissions', + 'revision': 'RevisionInfo' } attribute_map = { @@ -49,10 +50,11 @@ class Bucket(object): 'description': 'description', 'allow_bundle_redeploy': 'allowBundleRedeploy', 'allow_public_read': 'allowPublicRead', - 'permissions': 'permissions' + 'permissions': 'permissions', + 'revision': 'revision' } - def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None): + def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None, revision=None): """ Bucket - a model defined in Swagger """ @@ -65,6 +67,7 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self._allow_bundle_redeploy = None self._allow_public_read = None self._permissions = None + self._revision = None if link is not None: self.link = link @@ -81,6 +84,8 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self.allow_public_read = allow_public_read if permissions is not None: self.permissions = permissions + if revision is not None: + self.revision = revision @property def link(self): @@ -270,6 +275,29 @@ def permissions(self, permissions): self._permissions = permissions + @property + def revision(self): + """ + Gets the revision of this Bucket. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this Bucket. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this Bucket. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this Bucket. + :type: RevisionInfo + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/bucket_dto.py b/nipyapi/nifi/models/bucket_dto.py index 36f4fc52..bd98b99b 100644 --- a/nipyapi/nifi/models/bucket_dto.py +++ b/nipyapi/nifi/models/bucket_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bucket_entity.py b/nipyapi/nifi/models/bucket_entity.py index 78214122..fa24bdc6 100644 --- a/nipyapi/nifi/models/bucket_entity.py +++ b/nipyapi/nifi/models/bucket_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/buckets_entity.py b/nipyapi/nifi/models/buckets_entity.py index d06480bd..8fadb8e4 100644 --- a/nipyapi/nifi/models/buckets_entity.py +++ b/nipyapi/nifi/models/buckets_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_dto.py b/nipyapi/nifi/models/bulletin_board_dto.py index 41f1fb78..d7dd2b00 100644 --- a/nipyapi/nifi/models/bulletin_board_dto.py +++ b/nipyapi/nifi/models/bulletin_board_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_entity.py b/nipyapi/nifi/models/bulletin_board_entity.py index 2f2c1552..869aea0c 100644 --- a/nipyapi/nifi/models/bulletin_board_entity.py +++ b/nipyapi/nifi/models/bulletin_board_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_dto.py b/nipyapi/nifi/models/bulletin_dto.py index 0cf0a10c..acdce196 100644 --- a/nipyapi/nifi/models/bulletin_dto.py +++ b/nipyapi/nifi/models/bulletin_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_entity.py b/nipyapi/nifi/models/bulletin_entity.py index 08fdb922..43c31216 100644 --- a/nipyapi/nifi/models/bulletin_entity.py +++ b/nipyapi/nifi/models/bulletin_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle.py b/nipyapi/nifi/models/bundle.py index ec3e6864..37f19a36 100644 --- a/nipyapi/nifi/models/bundle.py +++ b/nipyapi/nifi/models/bundle.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle_dto.py b/nipyapi/nifi/models/bundle_dto.py index a8d98581..69b2ce88 100644 --- a/nipyapi/nifi/models/bundle_dto.py +++ b/nipyapi/nifi/models/bundle_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluste_summary_entity.py b/nipyapi/nifi/models/cluste_summary_entity.py index 0ea638e2..8149ca64 100644 --- a/nipyapi/nifi/models/cluste_summary_entity.py +++ b/nipyapi/nifi/models/cluste_summary_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_dto.py b/nipyapi/nifi/models/cluster_dto.py index fd44e2ca..abda8062 100644 --- a/nipyapi/nifi/models/cluster_dto.py +++ b/nipyapi/nifi/models/cluster_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_entity.py b/nipyapi/nifi/models/cluster_entity.py index c8fe393d..92c0fe63 100644 --- a/nipyapi/nifi/models/cluster_entity.py +++ b/nipyapi/nifi/models/cluster_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_search_results_entity.py b/nipyapi/nifi/models/cluster_search_results_entity.py index 99b7dfe5..45c52872 100644 --- a/nipyapi/nifi/models/cluster_search_results_entity.py +++ b/nipyapi/nifi/models/cluster_search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_summary_dto.py b/nipyapi/nifi/models/cluster_summary_dto.py index 8c5c0fde..0b1fb9d4 100644 --- a/nipyapi/nifi/models/cluster_summary_dto.py +++ b/nipyapi/nifi/models/cluster_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_details_dto.py b/nipyapi/nifi/models/component_details_dto.py index c4dc085a..063ba23e 100644 --- a/nipyapi/nifi/models/component_details_dto.py +++ b/nipyapi/nifi/models/component_details_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,11 +31,11 @@ class ComponentDetailsDTO(object): and the value is json key in definition. """ swagger_types = { - + } attribute_map = { - + } def __init__(self): diff --git a/nipyapi/nifi/models/component_difference_dto.py b/nipyapi/nifi/models/component_difference_dto.py index d8a34928..197abadb 100644 --- a/nipyapi/nifi/models/component_difference_dto.py +++ b/nipyapi/nifi/models/component_difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_dto.py b/nipyapi/nifi/models/component_history_dto.py index ce6fd8cd..51606f7d 100644 --- a/nipyapi/nifi/models/component_history_dto.py +++ b/nipyapi/nifi/models/component_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_entity.py b/nipyapi/nifi/models/component_history_entity.py index 04579d58..acb777e2 100644 --- a/nipyapi/nifi/models/component_history_entity.py +++ b/nipyapi/nifi/models/component_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_dto.py b/nipyapi/nifi/models/component_reference_dto.py index fe8bdc05..b08cc0ef 100644 --- a/nipyapi/nifi/models/component_reference_dto.py +++ b/nipyapi/nifi/models/component_reference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_entity.py b/nipyapi/nifi/models/component_reference_entity.py index 65f3e6ce..4ad4d105 100644 --- a/nipyapi/nifi/models/component_reference_entity.py +++ b/nipyapi/nifi/models/component_reference_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_restriction_permission_dto.py b/nipyapi/nifi/models/component_restriction_permission_dto.py index 2853da4c..84b968fa 100644 --- a/nipyapi/nifi/models/component_restriction_permission_dto.py +++ b/nipyapi/nifi/models/component_restriction_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_search_result_dto.py b/nipyapi/nifi/models/component_search_result_dto.py index 0b7ce870..82b8be0a 100644 --- a/nipyapi/nifi/models/component_search_result_dto.py +++ b/nipyapi/nifi/models/component_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_dto.py b/nipyapi/nifi/models/component_state_dto.py index 73530472..4c9920c6 100644 --- a/nipyapi/nifi/models/component_state_dto.py +++ b/nipyapi/nifi/models/component_state_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_entity.py b/nipyapi/nifi/models/component_state_entity.py index 24c64d77..1ce9cfd9 100644 --- a/nipyapi/nifi/models/component_state_entity.py +++ b/nipyapi/nifi/models/component_state_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_dto.py b/nipyapi/nifi/models/component_validation_result_dto.py index 67cfa91e..b9ffc740 100644 --- a/nipyapi/nifi/models/component_validation_result_dto.py +++ b/nipyapi/nifi/models/component_validation_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_entity.py b/nipyapi/nifi/models/component_validation_result_entity.py index a1a61118..9e396058 100644 --- a/nipyapi/nifi/models/component_validation_result_entity.py +++ b/nipyapi/nifi/models/component_validation_result_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_results_entity.py b/nipyapi/nifi/models/component_validation_results_entity.py index aa51d977..815d2c94 100644 --- a/nipyapi/nifi/models/component_validation_results_entity.py +++ b/nipyapi/nifi/models/component_validation_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_component.py b/nipyapi/nifi/models/connectable_component.py index dc434e13..4d8dfc5d 100644 --- a/nipyapi/nifi/models/connectable_component.py +++ b/nipyapi/nifi/models/connectable_component.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_dto.py b/nipyapi/nifi/models/connectable_dto.py index 14d0b65d..63d4535a 100644 --- a/nipyapi/nifi/models/connectable_dto.py +++ b/nipyapi/nifi/models/connectable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_dto.py b/nipyapi/nifi/models/connection_dto.py index 0a496678..732c8866 100644 --- a/nipyapi/nifi/models/connection_dto.py +++ b/nipyapi/nifi/models/connection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_entity.py b/nipyapi/nifi/models/connection_entity.py index b1e8635d..b1ce9a78 100644 --- a/nipyapi/nifi/models/connection_entity.py +++ b/nipyapi/nifi/models/connection_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_dto.py b/nipyapi/nifi/models/connection_statistics_dto.py index cea241f3..ef587ca8 100644 --- a/nipyapi/nifi/models/connection_statistics_dto.py +++ b/nipyapi/nifi/models/connection_statistics_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_entity.py b/nipyapi/nifi/models/connection_statistics_entity.py index fa1683ac..c7f11781 100644 --- a/nipyapi/nifi/models/connection_statistics_entity.py +++ b/nipyapi/nifi/models/connection_statistics_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py index 6d51db4b..1a83941e 100644 --- a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_dto.py b/nipyapi/nifi/models/connection_status_dto.py index 8a745015..50e1003a 100644 --- a/nipyapi/nifi/models/connection_status_dto.py +++ b/nipyapi/nifi/models/connection_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_entity.py b/nipyapi/nifi/models/connection_status_entity.py index 58a35de1..c752bebc 100644 --- a/nipyapi/nifi/models/connection_status_entity.py +++ b/nipyapi/nifi/models/connection_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py index 81c8bbad..d61f6df3 100644 --- a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_dto.py b/nipyapi/nifi/models/connection_status_snapshot_dto.py index 453ba392..7ab81323 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_entity.py b/nipyapi/nifi/models/connection_status_snapshot_entity.py index 3a3f6cce..cefadf00 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_entity.py +++ b/nipyapi/nifi/models/connection_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connections_entity.py b/nipyapi/nifi/models/connections_entity.py index dd31e906..0cbd7ac8 100644 --- a/nipyapi/nifi/models/connections_entity.py +++ b/nipyapi/nifi/models/connections_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_bulletins_entity.py b/nipyapi/nifi/models/controller_bulletins_entity.py index 6128651f..ab58a2c7 100644 --- a/nipyapi/nifi/models/controller_bulletins_entity.py +++ b/nipyapi/nifi/models/controller_bulletins_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_dto.py b/nipyapi/nifi/models/controller_configuration_dto.py index 90257ff5..f42ad390 100644 --- a/nipyapi/nifi/models/controller_configuration_dto.py +++ b/nipyapi/nifi/models/controller_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_entity.py b/nipyapi/nifi/models/controller_configuration_entity.py index 460b7621..75e78bf4 100644 --- a/nipyapi/nifi/models/controller_configuration_entity.py +++ b/nipyapi/nifi/models/controller_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_dto.py b/nipyapi/nifi/models/controller_dto.py index e3f8762b..7518d650 100644 --- a/nipyapi/nifi/models/controller_dto.py +++ b/nipyapi/nifi/models/controller_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_entity.py b/nipyapi/nifi/models/controller_entity.py index 8a7680ec..0c4b120f 100644 --- a/nipyapi/nifi/models/controller_entity.py +++ b/nipyapi/nifi/models/controller_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api.py b/nipyapi/nifi/models/controller_service_api.py index 3bf1a937..fb1f8ff9 100644 --- a/nipyapi/nifi/models/controller_service_api.py +++ b/nipyapi/nifi/models/controller_service_api.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api_dto.py b/nipyapi/nifi/models/controller_service_api_dto.py index 7ee5cd93..ef7e5b44 100644 --- a/nipyapi/nifi/models/controller_service_api_dto.py +++ b/nipyapi/nifi/models/controller_service_api_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_dto.py b/nipyapi/nifi/models/controller_service_dto.py index 5ad3d253..669f40e6 100644 --- a/nipyapi/nifi/models/controller_service_dto.py +++ b/nipyapi/nifi/models/controller_service_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_entity.py b/nipyapi/nifi/models/controller_service_entity.py index d9dc5b67..0e875618 100644 --- a/nipyapi/nifi/models/controller_service_entity.py +++ b/nipyapi/nifi/models/controller_service_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index e8beffcc..34d13673 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_entity.py b/nipyapi/nifi/models/controller_service_referencing_component_entity.py index df644f11..d7cccbe8 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_components_entity.py b/nipyapi/nifi/models/controller_service_referencing_components_entity.py index 7503ee8e..a8060895 100644 --- a/nipyapi/nifi/models/controller_service_referencing_components_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_run_status_entity.py b/nipyapi/nifi/models/controller_service_run_status_entity.py index f5b7964f..83c69077 100644 --- a/nipyapi/nifi/models/controller_service_run_status_entity.py +++ b/nipyapi/nifi/models/controller_service_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_status_dto.py b/nipyapi/nifi/models/controller_service_status_dto.py index f7c3e253..e525121e 100644 --- a/nipyapi/nifi/models/controller_service_status_dto.py +++ b/nipyapi/nifi/models/controller_service_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_types_entity.py b/nipyapi/nifi/models/controller_service_types_entity.py index 5fc7a793..dd92096f 100644 --- a/nipyapi/nifi/models/controller_service_types_entity.py +++ b/nipyapi/nifi/models/controller_service_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_services_entity.py b/nipyapi/nifi/models/controller_services_entity.py index c92b906a..1f489836 100644 --- a/nipyapi/nifi/models/controller_services_entity.py +++ b/nipyapi/nifi/models/controller_services_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_dto.py b/nipyapi/nifi/models/controller_status_dto.py index 3a521c36..5a341acb 100644 --- a/nipyapi/nifi/models/controller_status_dto.py +++ b/nipyapi/nifi/models/controller_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_entity.py b/nipyapi/nifi/models/controller_status_entity.py index 37d55a04..ddf27917 100644 --- a/nipyapi/nifi/models/controller_status_entity.py +++ b/nipyapi/nifi/models/controller_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/copy_snippet_request_entity.py b/nipyapi/nifi/models/copy_snippet_request_entity.py index 6ce0062d..187651a1 100644 --- a/nipyapi/nifi/models/copy_snippet_request_entity.py +++ b/nipyapi/nifi/models/copy_snippet_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_dto.py b/nipyapi/nifi/models/counter_dto.py index 6dd70eca..c552c956 100644 --- a/nipyapi/nifi/models/counter_dto.py +++ b/nipyapi/nifi/models/counter_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_entity.py b/nipyapi/nifi/models/counter_entity.py index b09fa3c4..6f83cc26 100644 --- a/nipyapi/nifi/models/counter_entity.py +++ b/nipyapi/nifi/models/counter_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_dto.py b/nipyapi/nifi/models/counters_dto.py index 19525e0c..d1fefd4a 100644 --- a/nipyapi/nifi/models/counters_dto.py +++ b/nipyapi/nifi/models/counters_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_entity.py b/nipyapi/nifi/models/counters_entity.py index dae8ee72..90661818 100644 --- a/nipyapi/nifi/models/counters_entity.py +++ b/nipyapi/nifi/models/counters_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_snapshot_dto.py b/nipyapi/nifi/models/counters_snapshot_dto.py index 0b33ab9d..b1ab06fd 100644 --- a/nipyapi/nifi/models/counters_snapshot_dto.py +++ b/nipyapi/nifi/models/counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_active_request_entity.py b/nipyapi/nifi/models/create_active_request_entity.py index e79e89b6..7dbc4be5 100644 --- a/nipyapi/nifi/models/create_active_request_entity.py +++ b/nipyapi/nifi/models/create_active_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_template_request_entity.py b/nipyapi/nifi/models/create_template_request_entity.py index febc4161..2070f43f 100644 --- a/nipyapi/nifi/models/create_template_request_entity.py +++ b/nipyapi/nifi/models/create_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/current_user_entity.py b/nipyapi/nifi/models/current_user_entity.py index 09d2e135..456d0722 100644 --- a/nipyapi/nifi/models/current_user_entity.py +++ b/nipyapi/nifi/models/current_user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/difference_dto.py b/nipyapi/nifi/models/difference_dto.py index ada45412..58edaabc 100644 --- a/nipyapi/nifi/models/difference_dto.py +++ b/nipyapi/nifi/models/difference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dimensions_dto.py b/nipyapi/nifi/models/dimensions_dto.py index db96369a..6ed1c886 100644 --- a/nipyapi/nifi/models/dimensions_dto.py +++ b/nipyapi/nifi/models/dimensions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/documented_type_dto.py b/nipyapi/nifi/models/documented_type_dto.py index 417ede00..dde13905 100644 --- a/nipyapi/nifi/models/documented_type_dto.py +++ b/nipyapi/nifi/models/documented_type_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_dto.py b/nipyapi/nifi/models/drop_request_dto.py index 5341366b..4cef67b3 100644 --- a/nipyapi/nifi/models/drop_request_dto.py +++ b/nipyapi/nifi/models/drop_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_entity.py b/nipyapi/nifi/models/drop_request_entity.py index 731011b9..d0347cc0 100644 --- a/nipyapi/nifi/models/drop_request_entity.py +++ b/nipyapi/nifi/models/drop_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/explicit_restriction_dto.py b/nipyapi/nifi/models/explicit_restriction_dto.py index 61f41e07..762a9038 100644 --- a/nipyapi/nifi/models/explicit_restriction_dto.py +++ b/nipyapi/nifi/models/explicit_restriction_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/external_controller_service_reference.py b/nipyapi/nifi/models/external_controller_service_reference.py index 4869e2e7..0b240532 100644 --- a/nipyapi/nifi/models/external_controller_service_reference.py +++ b/nipyapi/nifi/models/external_controller_service_reference.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_dto.py b/nipyapi/nifi/models/flow_breadcrumb_dto.py index 6874b8a4..262a0403 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_dto.py +++ b/nipyapi/nifi/models/flow_breadcrumb_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_entity.py b/nipyapi/nifi/models/flow_breadcrumb_entity.py index eac2b362..43d36144 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_entity.py +++ b/nipyapi/nifi/models/flow_breadcrumb_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_comparison_entity.py b/nipyapi/nifi/models/flow_comparison_entity.py index eb3d4eba..cbffb727 100644 --- a/nipyapi/nifi/models/flow_comparison_entity.py +++ b/nipyapi/nifi/models/flow_comparison_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_dto.py b/nipyapi/nifi/models/flow_configuration_dto.py index 5d67a1a1..6616d284 100644 --- a/nipyapi/nifi/models/flow_configuration_dto.py +++ b/nipyapi/nifi/models/flow_configuration_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_entity.py b/nipyapi/nifi/models/flow_configuration_entity.py index d7682fce..f1f4e4bf 100644 --- a/nipyapi/nifi/models/flow_configuration_entity.py +++ b/nipyapi/nifi/models/flow_configuration_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_dto.py b/nipyapi/nifi/models/flow_dto.py index acecdb43..e496f1a2 100644 --- a/nipyapi/nifi/models/flow_dto.py +++ b/nipyapi/nifi/models/flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_entity.py b/nipyapi/nifi/models/flow_entity.py index 62ab08b5..f20cc72a 100644 --- a/nipyapi/nifi/models/flow_entity.py +++ b/nipyapi/nifi/models/flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_dto.py b/nipyapi/nifi/models/flow_file_dto.py index f94c45cf..f8764d5d 100644 --- a/nipyapi/nifi/models/flow_file_dto.py +++ b/nipyapi/nifi/models/flow_file_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_entity.py b/nipyapi/nifi/models/flow_file_entity.py index 810d5dcf..df9989e7 100644 --- a/nipyapi/nifi/models/flow_file_entity.py +++ b/nipyapi/nifi/models/flow_file_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_summary_dto.py b/nipyapi/nifi/models/flow_file_summary_dto.py index 974b2b6f..3a4097f8 100644 --- a/nipyapi/nifi/models/flow_file_summary_dto.py +++ b/nipyapi/nifi/models/flow_file_summary_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_snippet_dto.py b/nipyapi/nifi/models/flow_snippet_dto.py index 137faf14..582078ff 100644 --- a/nipyapi/nifi/models/flow_snippet_dto.py +++ b/nipyapi/nifi/models/flow_snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_dto.py b/nipyapi/nifi/models/funnel_dto.py index 07683243..41dafc91 100644 --- a/nipyapi/nifi/models/funnel_dto.py +++ b/nipyapi/nifi/models/funnel_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_entity.py b/nipyapi/nifi/models/funnel_entity.py index e7218b1d..d0051ba8 100644 --- a/nipyapi/nifi/models/funnel_entity.py +++ b/nipyapi/nifi/models/funnel_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnels_entity.py b/nipyapi/nifi/models/funnels_entity.py index 2c1b5b4f..794bb137 100644 --- a/nipyapi/nifi/models/funnels_entity.py +++ b/nipyapi/nifi/models/funnels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/garbage_collection_dto.py b/nipyapi/nifi/models/garbage_collection_dto.py index 886821b3..7cb1df53 100644 --- a/nipyapi/nifi/models/garbage_collection_dto.py +++ b/nipyapi/nifi/models/garbage_collection_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_dto.py b/nipyapi/nifi/models/history_dto.py index 602656a6..384da45f 100644 --- a/nipyapi/nifi/models/history_dto.py +++ b/nipyapi/nifi/models/history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_entity.py b/nipyapi/nifi/models/history_entity.py index 3516fa0b..14f0bd4e 100644 --- a/nipyapi/nifi/models/history_entity.py +++ b/nipyapi/nifi/models/history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/input_ports_entity.py b/nipyapi/nifi/models/input_ports_entity.py index d3b1bdbf..6f1f4a72 100644 --- a/nipyapi/nifi/models/input_ports_entity.py +++ b/nipyapi/nifi/models/input_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/instantiate_template_request_entity.py b/nipyapi/nifi/models/instantiate_template_request_entity.py index e52353c7..1cc78930 100644 --- a/nipyapi/nifi/models/instantiate_template_request_entity.py +++ b/nipyapi/nifi/models/instantiate_template_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jaxb_link.py b/nipyapi/nifi/models/jaxb_link.py index 804a716b..401967f0 100644 --- a/nipyapi/nifi/models/jaxb_link.py +++ b/nipyapi/nifi/models/jaxb_link.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_dto.py b/nipyapi/nifi/models/label_dto.py index 4382ff65..c2d486a0 100644 --- a/nipyapi/nifi/models/label_dto.py +++ b/nipyapi/nifi/models/label_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_entity.py b/nipyapi/nifi/models/label_entity.py index 6ffb4ee3..e9eed2fc 100644 --- a/nipyapi/nifi/models/label_entity.py +++ b/nipyapi/nifi/models/label_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/labels_entity.py b/nipyapi/nifi/models/labels_entity.py index 3252ce02..7e4e314c 100644 --- a/nipyapi/nifi/models/labels_entity.py +++ b/nipyapi/nifi/models/labels_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_dto.py b/nipyapi/nifi/models/lineage_dto.py index 689612ea..a1c3e473 100644 --- a/nipyapi/nifi/models/lineage_dto.py +++ b/nipyapi/nifi/models/lineage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_entity.py b/nipyapi/nifi/models/lineage_entity.py index 5ed86a3a..8731b6c1 100644 --- a/nipyapi/nifi/models/lineage_entity.py +++ b/nipyapi/nifi/models/lineage_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_request_dto.py b/nipyapi/nifi/models/lineage_request_dto.py index 5c6a42b3..e39fb540 100644 --- a/nipyapi/nifi/models/lineage_request_dto.py +++ b/nipyapi/nifi/models/lineage_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_results_dto.py b/nipyapi/nifi/models/lineage_results_dto.py index b2878964..bcd0061e 100644 --- a/nipyapi/nifi/models/lineage_results_dto.py +++ b/nipyapi/nifi/models/lineage_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/listing_request_dto.py b/nipyapi/nifi/models/listing_request_dto.py index 853a845e..4e2c3132 100644 --- a/nipyapi/nifi/models/listing_request_dto.py +++ b/nipyapi/nifi/models/listing_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,8 +42,8 @@ class ListingRequestDTO(object): 'state': 'str', 'queue_size': 'QueueSizeDTO', 'flow_file_summaries': 'list[FlowFileSummaryDTO]', - 'source_running': 'bool', - 'destination_running': 'bool' + 'destination_running': 'bool', + 'source_running': 'bool' } attribute_map = { @@ -58,11 +58,11 @@ class ListingRequestDTO(object): 'state': 'state', 'queue_size': 'queueSize', 'flow_file_summaries': 'flowFileSummaries', - 'source_running': 'sourceRunning', - 'destination_running': 'destinationRunning' + 'destination_running': 'destinationRunning', + 'source_running': 'sourceRunning' } - def __init__(self, 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): + def __init__(self, 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, destination_running=None, source_running=None): """ ListingRequestDTO - a model defined in Swagger """ @@ -78,8 +78,8 @@ def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, p self._state = None self._queue_size = None self._flow_file_summaries = None - self._source_running = None self._destination_running = None + self._source_running = None if id is not None: self.id = id @@ -103,10 +103,10 @@ def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, p self.queue_size = queue_size if flow_file_summaries is not None: self.flow_file_summaries = flow_file_summaries - if source_running is not None: - self.source_running = source_running if destination_running is not None: self.destination_running = destination_running + if source_running is not None: + self.source_running = source_running @property def id(self): @@ -362,50 +362,50 @@ def flow_file_summaries(self, flow_file_summaries): self._flow_file_summaries = flow_file_summaries @property - def source_running(self): + def destination_running(self): """ - Gets the source_running of this ListingRequestDTO. - Whether the source of the connection is running + Gets the destination_running of this ListingRequestDTO. + Whether the destination of the connection is running - :return: The source_running of this ListingRequestDTO. + :return: The destination_running of this ListingRequestDTO. :rtype: bool """ - return self._source_running + return self._destination_running - @source_running.setter - def source_running(self, source_running): + @destination_running.setter + def destination_running(self, destination_running): """ - Sets the source_running of this ListingRequestDTO. - Whether the source of the connection is running + Sets the destination_running of this ListingRequestDTO. + Whether the destination of the connection is running - :param source_running: The source_running of this ListingRequestDTO. + :param destination_running: The destination_running of this ListingRequestDTO. :type: bool """ - self._source_running = source_running + self._destination_running = destination_running @property - def destination_running(self): + def source_running(self): """ - Gets the destination_running of this ListingRequestDTO. - Whether the destination of the connection is running + Gets the source_running of this ListingRequestDTO. + Whether the source of the connection is running - :return: The destination_running of this ListingRequestDTO. + :return: The source_running of this ListingRequestDTO. :rtype: bool """ - return self._destination_running + return self._source_running - @destination_running.setter - def destination_running(self, destination_running): + @source_running.setter + def source_running(self, source_running): """ - Sets the destination_running of this ListingRequestDTO. - Whether the destination of the connection is running + Sets the source_running of this ListingRequestDTO. + Whether the source of the connection is running - :param destination_running: The destination_running of this ListingRequestDTO. + :param source_running: The source_running of this ListingRequestDTO. :type: bool """ - self._destination_running = destination_running + self._source_running = source_running def to_dict(self): """ diff --git a/nipyapi/nifi/models/listing_request_entity.py b/nipyapi/nifi/models/listing_request_entity.py index 279c6d86..795757d4 100644 --- a/nipyapi/nifi/models/listing_request_entity.py +++ b/nipyapi/nifi/models/listing_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py index bbbf721c..390fb403 100644 --- a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py index 95d7f620..037f9979 100644 --- a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_counters_snapshot_dto.py b/nipyapi/nifi/models/node_counters_snapshot_dto.py index 51a70002..dfdd5f97 100644 --- a/nipyapi/nifi/models/node_counters_snapshot_dto.py +++ b/nipyapi/nifi/models/node_counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_dto.py b/nipyapi/nifi/models/node_dto.py index d617b117..c3ab17f8 100644 --- a/nipyapi/nifi/models/node_dto.py +++ b/nipyapi/nifi/models/node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_entity.py b/nipyapi/nifi/models/node_entity.py index a0bfe490..411e245b 100644 --- a/nipyapi/nifi/models/node_entity.py +++ b/nipyapi/nifi/models/node_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_event_dto.py b/nipyapi/nifi/models/node_event_dto.py index 796cc0e2..55f81273 100644 --- a/nipyapi/nifi/models/node_event_dto.py +++ b/nipyapi/nifi/models/node_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_port_status_snapshot_dto.py b/nipyapi/nifi/models/node_port_status_snapshot_dto.py index dc059c1b..8732b3e1 100644 --- a/nipyapi/nifi/models/node_port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py index eedfbf0a..44b641d0 100644 --- a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py index eb62aa3c..4ff1245e 100644 --- a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py index fb727230..23f8c95d 100644 --- a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_search_result_dto.py b/nipyapi/nifi/models/node_search_result_dto.py index 2a05e600..6eb6741c 100644 --- a/nipyapi/nifi/models/node_search_result_dto.py +++ b/nipyapi/nifi/models/node_search_result_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_status_snapshots_dto.py b/nipyapi/nifi/models/node_status_snapshots_dto.py index 77330319..e1e1453f 100644 --- a/nipyapi/nifi/models/node_status_snapshots_dto.py +++ b/nipyapi/nifi/models/node_status_snapshots_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py index 03f56117..39fe1eda 100644 --- a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/output_ports_entity.py b/nipyapi/nifi/models/output_ports_entity.py index 15e06705..abebcc27 100644 --- a/nipyapi/nifi/models/output_ports_entity.py +++ b/nipyapi/nifi/models/output_ports_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_dto.py b/nipyapi/nifi/models/parameter_context_dto.py index 6f7cb8f9..ab0161bf 100644 --- a/nipyapi/nifi/models/parameter_context_dto.py +++ b/nipyapi/nifi/models/parameter_context_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_entity.py b/nipyapi/nifi/models/parameter_context_entity.py index 835aa523..9ae7dbe1 100644 --- a/nipyapi/nifi/models/parameter_context_entity.py +++ b/nipyapi/nifi/models/parameter_context_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_reference_dto.py b/nipyapi/nifi/models/parameter_context_reference_dto.py index e68e61b2..b62a0924 100644 --- a/nipyapi/nifi/models/parameter_context_reference_dto.py +++ b/nipyapi/nifi/models/parameter_context_reference_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_reference_entity.py b/nipyapi/nifi/models/parameter_context_reference_entity.py index 354386af..2cae7ebb 100644 --- a/nipyapi/nifi/models/parameter_context_reference_entity.py +++ b/nipyapi/nifi/models/parameter_context_reference_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_dto.py b/nipyapi/nifi/models/parameter_context_update_request_dto.py index 48520c5f..ecab8845 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_entity.py b/nipyapi/nifi/models/parameter_context_update_request_entity.py index 44142551..324e7c16 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_step_dto.py b/nipyapi/nifi/models/parameter_context_update_step_dto.py index eb1ec9ed..b95302a3 100644 --- a/nipyapi/nifi/models/parameter_context_update_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_dto.py b/nipyapi/nifi/models/parameter_context_validation_request_dto.py index f8781b7d..d11d474a 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_entity.py b/nipyapi/nifi/models/parameter_context_validation_request_entity.py index b5b9c6c2..f816eb8d 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_step_dto.py b/nipyapi/nifi/models/parameter_context_validation_step_dto.py index 01fd769e..47023ff1 100644 --- a/nipyapi/nifi/models/parameter_context_validation_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_contexts_entity.py b/nipyapi/nifi/models/parameter_contexts_entity.py index 4af00b29..a931171c 100644 --- a/nipyapi/nifi/models/parameter_contexts_entity.py +++ b/nipyapi/nifi/models/parameter_contexts_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_dto.py b/nipyapi/nifi/models/parameter_dto.py index 10c59f0b..4614f973 100644 --- a/nipyapi/nifi/models/parameter_dto.py +++ b/nipyapi/nifi/models/parameter_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_entity.py b/nipyapi/nifi/models/parameter_entity.py index d72acbb6..0dc099c5 100644 --- a/nipyapi/nifi/models/parameter_entity.py +++ b/nipyapi/nifi/models/parameter_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peer_dto.py b/nipyapi/nifi/models/peer_dto.py index a7894526..97dbab2d 100644 --- a/nipyapi/nifi/models/peer_dto.py +++ b/nipyapi/nifi/models/peer_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peers_entity.py b/nipyapi/nifi/models/peers_entity.py index acca895a..5b981b62 100644 --- a/nipyapi/nifi/models/peers_entity.py +++ b/nipyapi/nifi/models/peers_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions.py b/nipyapi/nifi/models/permissions.py index c8ff2871..b67df2e8 100644 --- a/nipyapi/nifi/models/permissions.py +++ b/nipyapi/nifi/models/permissions.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions_dto.py b/nipyapi/nifi/models/permissions_dto.py index 60a99ee1..90be1bf9 100644 --- a/nipyapi/nifi/models/permissions_dto.py +++ b/nipyapi/nifi/models/permissions_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_dto.py b/nipyapi/nifi/models/port_dto.py index e814b456..58417289 100644 --- a/nipyapi/nifi/models/port_dto.py +++ b/nipyapi/nifi/models/port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_entity.py b/nipyapi/nifi/models/port_entity.py index eda1695e..a8ad9693 100644 --- a/nipyapi/nifi/models/port_entity.py +++ b/nipyapi/nifi/models/port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_run_status_entity.py b/nipyapi/nifi/models/port_run_status_entity.py index bab6d952..47a882af 100644 --- a/nipyapi/nifi/models/port_run_status_entity.py +++ b/nipyapi/nifi/models/port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_dto.py b/nipyapi/nifi/models/port_status_dto.py index eac5f8ae..b56b66a6 100644 --- a/nipyapi/nifi/models/port_status_dto.py +++ b/nipyapi/nifi/models/port_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_entity.py b/nipyapi/nifi/models/port_status_entity.py index e608ff8f..6ee414b9 100644 --- a/nipyapi/nifi/models/port_status_entity.py +++ b/nipyapi/nifi/models/port_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_dto.py b/nipyapi/nifi/models/port_status_snapshot_dto.py index 131ef238..7c38f634 100644 --- a/nipyapi/nifi/models/port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_entity.py b/nipyapi/nifi/models/port_status_snapshot_entity.py index c6af4fc4..18f4f08c 100644 --- a/nipyapi/nifi/models/port_status_snapshot_entity.py +++ b/nipyapi/nifi/models/port_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position.py b/nipyapi/nifi/models/position.py index 0f7bbaf9..7ebadcfb 100644 --- a/nipyapi/nifi/models/position.py +++ b/nipyapi/nifi/models/position.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position_dto.py b/nipyapi/nifi/models/position_dto.py index 1a39eb72..94635bd7 100644 --- a/nipyapi/nifi/models/position_dto.py +++ b/nipyapi/nifi/models/position_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/previous_value_dto.py b/nipyapi/nifi/models/previous_value_dto.py index ca41853d..05217cf6 100644 --- a/nipyapi/nifi/models/previous_value_dto.py +++ b/nipyapi/nifi/models/previous_value_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/prioritizer_types_entity.py b/nipyapi/nifi/models/prioritizer_types_entity.py index 42f1383d..1d4b346e 100644 --- a/nipyapi/nifi/models/prioritizer_types_entity.py +++ b/nipyapi/nifi/models/prioritizer_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_dto.py b/nipyapi/nifi/models/process_group_dto.py index 404ed6eb..09cc09a8 100644 --- a/nipyapi/nifi/models/process_group_dto.py +++ b/nipyapi/nifi/models/process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -40,6 +40,8 @@ class ProcessGroupDTO(object): 'variables': 'dict(str, str)', 'version_control_information': 'VersionControlInformationDTO', 'parameter_context': 'ParameterContextReferenceEntity', + 'flowfile_concurrency': 'str', + 'flowfile_outbound_policy': 'str', 'running_count': 'int', 'stopped_count': 'int', 'invalid_count': 'int', @@ -70,6 +72,8 @@ class ProcessGroupDTO(object): 'variables': 'variables', 'version_control_information': 'versionControlInformation', 'parameter_context': 'parameterContext', + 'flowfile_concurrency': 'flowfileConcurrency', + 'flowfile_outbound_policy': 'flowfileOutboundPolicy', 'running_count': 'runningCount', 'stopped_count': 'stoppedCount', 'invalid_count': 'invalidCount', @@ -90,7 +94,7 @@ class ProcessGroupDTO(object): 'output_port_count': 'outputPortCount' } - def __init__(self, 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, 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): + def __init__(self, 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, 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): """ ProcessGroupDTO - a model defined in Swagger """ @@ -104,6 +108,8 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self._variables = None self._version_control_information = None self._parameter_context = None + self._flowfile_concurrency = None + self._flowfile_outbound_policy = None self._running_count = None self._stopped_count = None self._invalid_count = None @@ -141,6 +147,10 @@ def __init__(self, id=None, versioned_component_id=None, parent_group_id=None, p self.version_control_information = version_control_information if parameter_context is not None: self.parameter_context = parameter_context + if flowfile_concurrency is not None: + self.flowfile_concurrency = flowfile_concurrency + if flowfile_outbound_policy is not None: + self.flowfile_outbound_policy = flowfile_outbound_policy if running_count is not None: self.running_count = running_count if stopped_count is not None: @@ -385,6 +395,64 @@ def parameter_context(self, parameter_context): self._parameter_context = parameter_context + @property + def flowfile_concurrency(self): + """ + Gets the flowfile_concurrency of this ProcessGroupDTO. + The FlowFile Concurrency for this Process Group. + + :return: The flowfile_concurrency of this ProcessGroupDTO. + :rtype: str + """ + return self._flowfile_concurrency + + @flowfile_concurrency.setter + def flowfile_concurrency(self, flowfile_concurrency): + """ + Sets the flowfile_concurrency of this ProcessGroupDTO. + The FlowFile Concurrency for this Process Group. + + :param flowfile_concurrency: The flowfile_concurrency of this ProcessGroupDTO. + :type: str + """ + allowed_values = ["UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE"] + if flowfile_concurrency not in allowed_values: + raise ValueError( + "Invalid value for `flowfile_concurrency` ({0}), must be one of {1}" + .format(flowfile_concurrency, allowed_values) + ) + + self._flowfile_concurrency = flowfile_concurrency + + @property + def flowfile_outbound_policy(self): + """ + Gets the flowfile_outbound_policy of this ProcessGroupDTO. + The Oubound Policy that is used for determining how FlowFiles should be transferred out of the Process Group. + + :return: The flowfile_outbound_policy of this ProcessGroupDTO. + :rtype: str + """ + return self._flowfile_outbound_policy + + @flowfile_outbound_policy.setter + def flowfile_outbound_policy(self, flowfile_outbound_policy): + """ + Sets the flowfile_outbound_policy of this ProcessGroupDTO. + The Oubound Policy that is used for determining how FlowFiles should be transferred out of the Process Group. + + :param flowfile_outbound_policy: The flowfile_outbound_policy of this ProcessGroupDTO. + :type: str + """ + allowed_values = ["STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT"] + if flowfile_outbound_policy not in allowed_values: + raise ValueError( + "Invalid value for `flowfile_outbound_policy` ({0}), must be one of {1}" + .format(flowfile_outbound_policy, allowed_values) + ) + + self._flowfile_outbound_policy = flowfile_outbound_policy + @property def running_count(self): """ diff --git a/nipyapi/nifi/models/process_group_entity.py b/nipyapi/nifi/models/process_group_entity.py index 45b946af..9e3c3357 100644 --- a/nipyapi/nifi/models/process_group_entity.py +++ b/nipyapi/nifi/models/process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_flow_dto.py b/nipyapi/nifi/models/process_group_flow_dto.py index 2301720a..81acaa43 100644 --- a/nipyapi/nifi/models/process_group_flow_dto.py +++ b/nipyapi/nifi/models/process_group_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_flow_entity.py b/nipyapi/nifi/models/process_group_flow_entity.py index 9fa3549b..1f756ffd 100644 --- a/nipyapi/nifi/models/process_group_flow_entity.py +++ b/nipyapi/nifi/models/process_group_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_import_entity.py b/nipyapi/nifi/models/process_group_import_entity.py new file mode 100644 index 00000000..2c1ae682 --- /dev/null +++ b/nipyapi/nifi/models/process_group_import_entity.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessGroupImportEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'process_group_revision': 'RevisionDTO', + 'disconnected_node_acknowledged': 'bool', + 'versioned_flow_snapshot': 'VersionedFlowSnapshot' + } + + attribute_map = { + 'process_group_revision': 'processGroupRevision', + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', + 'versioned_flow_snapshot': 'versionedFlowSnapshot' + } + + def __init__(self, process_group_revision=None, disconnected_node_acknowledged=None, versioned_flow_snapshot=None): + """ + ProcessGroupImportEntity - a model defined in Swagger + """ + + self._process_group_revision = None + self._disconnected_node_acknowledged = None + self._versioned_flow_snapshot = None + + if process_group_revision is not None: + self.process_group_revision = process_group_revision + if disconnected_node_acknowledged is not None: + self.disconnected_node_acknowledged = disconnected_node_acknowledged + if versioned_flow_snapshot is not None: + self.versioned_flow_snapshot = versioned_flow_snapshot + + @property + def process_group_revision(self): + """ + Gets the process_group_revision of this ProcessGroupImportEntity. + The Revision for the Process Group + + :return: The process_group_revision of this ProcessGroupImportEntity. + :rtype: RevisionDTO + """ + return self._process_group_revision + + @process_group_revision.setter + def process_group_revision(self, process_group_revision): + """ + Sets the process_group_revision of this ProcessGroupImportEntity. + The Revision for the Process Group + + :param process_group_revision: The process_group_revision of this ProcessGroupImportEntity. + :type: RevisionDTO + """ + + self._process_group_revision = process_group_revision + + @property + def disconnected_node_acknowledged(self): + """ + Gets the disconnected_node_acknowledged of this ProcessGroupImportEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :return: The disconnected_node_acknowledged of this ProcessGroupImportEntity. + :rtype: bool + """ + return self._disconnected_node_acknowledged + + @disconnected_node_acknowledged.setter + def disconnected_node_acknowledged(self, disconnected_node_acknowledged): + """ + Sets the disconnected_node_acknowledged of this ProcessGroupImportEntity. + Acknowledges that this node is disconnected to allow for mutable requests to proceed. + + :param disconnected_node_acknowledged: The disconnected_node_acknowledged of this ProcessGroupImportEntity. + :type: bool + """ + + self._disconnected_node_acknowledged = disconnected_node_acknowledged + + @property + def versioned_flow_snapshot(self): + """ + Gets the versioned_flow_snapshot of this ProcessGroupImportEntity. + The Versioned Flow Snapshot to import + + :return: The versioned_flow_snapshot of this ProcessGroupImportEntity. + :rtype: VersionedFlowSnapshot + """ + return self._versioned_flow_snapshot + + @versioned_flow_snapshot.setter + def versioned_flow_snapshot(self, versioned_flow_snapshot): + """ + Sets the versioned_flow_snapshot of this ProcessGroupImportEntity. + The Versioned Flow Snapshot to import + + :param versioned_flow_snapshot: The versioned_flow_snapshot of this ProcessGroupImportEntity. + :type: VersionedFlowSnapshot + """ + + self._versioned_flow_snapshot = versioned_flow_snapshot + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessGroupImportEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/process_group_name_dto.py b/nipyapi/nifi/models/process_group_name_dto.py index dad2aec9..39492f8b 100644 --- a/nipyapi/nifi/models/process_group_name_dto.py +++ b/nipyapi/nifi/models/process_group_name_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_replace_request_dto.py b/nipyapi/nifi/models/process_group_replace_request_dto.py new file mode 100644 index 00000000..45cc9548 --- /dev/null +++ b/nipyapi/nifi/models/process_group_replace_request_dto.py @@ -0,0 +1,321 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessGroupReplaceRequestDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'request_id': 'str', + 'process_group_id': 'str', + 'uri': 'str', + 'last_updated': 'str', + 'complete': 'bool', + 'failure_reason': 'str', + 'percent_completed': 'int', + 'state': 'str' + } + + attribute_map = { + 'request_id': 'requestId', + 'process_group_id': 'processGroupId', + 'uri': 'uri', + 'last_updated': 'lastUpdated', + 'complete': 'complete', + 'failure_reason': 'failureReason', + 'percent_completed': 'percentCompleted', + 'state': 'state' + } + + def __init__(self, request_id=None, process_group_id=None, uri=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None): + """ + ProcessGroupReplaceRequestDTO - a model defined in Swagger + """ + + self._request_id = None + self._process_group_id = None + self._uri = None + self._last_updated = None + self._complete = None + self._failure_reason = None + self._percent_completed = None + self._state = None + + if request_id is not None: + self.request_id = request_id + if process_group_id is not None: + self.process_group_id = process_group_id + if uri is not None: + self.uri = uri + if last_updated is not None: + self.last_updated = last_updated + if complete is not None: + self.complete = complete + if failure_reason is not None: + self.failure_reason = failure_reason + if percent_completed is not None: + self.percent_completed = percent_completed + if state is not None: + self.state = state + + @property + def request_id(self): + """ + Gets the request_id of this ProcessGroupReplaceRequestDTO. + The unique ID of this request. + + :return: The request_id of this ProcessGroupReplaceRequestDTO. + :rtype: str + """ + return self._request_id + + @request_id.setter + def request_id(self, request_id): + """ + Sets the request_id of this ProcessGroupReplaceRequestDTO. + The unique ID of this request. + + :param request_id: The request_id of this ProcessGroupReplaceRequestDTO. + :type: str + """ + + self._request_id = request_id + + @property + def process_group_id(self): + """ + Gets the process_group_id of this ProcessGroupReplaceRequestDTO. + The unique ID of the Process Group being updated + + :return: The process_group_id of this ProcessGroupReplaceRequestDTO. + :rtype: str + """ + return self._process_group_id + + @process_group_id.setter + def process_group_id(self, process_group_id): + """ + Sets the process_group_id of this ProcessGroupReplaceRequestDTO. + The unique ID of the Process Group being updated + + :param process_group_id: The process_group_id of this ProcessGroupReplaceRequestDTO. + :type: str + """ + + self._process_group_id = process_group_id + + @property + def uri(self): + """ + Gets the uri of this ProcessGroupReplaceRequestDTO. + The URI for future requests to this drop request. + + :return: The uri of this ProcessGroupReplaceRequestDTO. + :rtype: str + """ + return self._uri + + @uri.setter + def uri(self, uri): + """ + Sets the uri of this ProcessGroupReplaceRequestDTO. + The URI for future requests to this drop request. + + :param uri: The uri of this ProcessGroupReplaceRequestDTO. + :type: str + """ + + self._uri = uri + + @property + def last_updated(self): + """ + Gets the last_updated of this ProcessGroupReplaceRequestDTO. + The last time this request was updated. + + :return: The last_updated of this ProcessGroupReplaceRequestDTO. + :rtype: str + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """ + Sets the last_updated of this ProcessGroupReplaceRequestDTO. + The last time this request was updated. + + :param last_updated: The last_updated of this ProcessGroupReplaceRequestDTO. + :type: str + """ + + self._last_updated = last_updated + + @property + def complete(self): + """ + Gets the complete of this ProcessGroupReplaceRequestDTO. + Whether or not this request has completed + + :return: The complete of this ProcessGroupReplaceRequestDTO. + :rtype: bool + """ + return self._complete + + @complete.setter + def complete(self, complete): + """ + Sets the complete of this ProcessGroupReplaceRequestDTO. + Whether or not this request has completed + + :param complete: The complete of this ProcessGroupReplaceRequestDTO. + :type: bool + """ + + self._complete = complete + + @property + def failure_reason(self): + """ + Gets the failure_reason of this ProcessGroupReplaceRequestDTO. + An explanation of why this request failed, or null if this request has not failed + + :return: The failure_reason of this ProcessGroupReplaceRequestDTO. + :rtype: str + """ + return self._failure_reason + + @failure_reason.setter + def failure_reason(self, failure_reason): + """ + Sets the failure_reason of this ProcessGroupReplaceRequestDTO. + An explanation of why this request failed, or null if this request has not failed + + :param failure_reason: The failure_reason of this ProcessGroupReplaceRequestDTO. + :type: str + """ + + self._failure_reason = failure_reason + + @property + def percent_completed(self): + """ + Gets the percent_completed of this ProcessGroupReplaceRequestDTO. + The percentage complete for the request, between 0 and 100 + + :return: The percent_completed of this ProcessGroupReplaceRequestDTO. + :rtype: int + """ + return self._percent_completed + + @percent_completed.setter + def percent_completed(self, percent_completed): + """ + Sets the percent_completed of this ProcessGroupReplaceRequestDTO. + The percentage complete for the request, between 0 and 100 + + :param percent_completed: The percent_completed of this ProcessGroupReplaceRequestDTO. + :type: int + """ + + self._percent_completed = percent_completed + + @property + def state(self): + """ + Gets the state of this ProcessGroupReplaceRequestDTO. + The state of the request + + :return: The state of this ProcessGroupReplaceRequestDTO. + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """ + Sets the state of this ProcessGroupReplaceRequestDTO. + The state of the request + + :param state: The state of this ProcessGroupReplaceRequestDTO. + :type: str + """ + + self._state = state + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessGroupReplaceRequestDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/process_group_replace_request_entity.py b/nipyapi/nifi/models/process_group_replace_request_entity.py new file mode 100644 index 00000000..2a146d01 --- /dev/null +++ b/nipyapi/nifi/models/process_group_replace_request_entity.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessGroupReplaceRequestEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'process_group_revision': 'RevisionDTO', + 'request': 'ProcessGroupReplaceRequestDTO', + 'versioned_flow_snapshot': 'VersionedFlowSnapshot' + } + + attribute_map = { + 'process_group_revision': 'processGroupRevision', + 'request': 'request', + 'versioned_flow_snapshot': 'versionedFlowSnapshot' + } + + def __init__(self, process_group_revision=None, request=None, versioned_flow_snapshot=None): + """ + ProcessGroupReplaceRequestEntity - a model defined in Swagger + """ + + self._process_group_revision = None + self._request = None + self._versioned_flow_snapshot = None + + if process_group_revision is not None: + self.process_group_revision = process_group_revision + if request is not None: + self.request = request + if versioned_flow_snapshot is not None: + self.versioned_flow_snapshot = versioned_flow_snapshot + + @property + def process_group_revision(self): + """ + Gets the process_group_revision of this ProcessGroupReplaceRequestEntity. + The revision for the Process Group being updated. + + :return: The process_group_revision of this ProcessGroupReplaceRequestEntity. + :rtype: RevisionDTO + """ + return self._process_group_revision + + @process_group_revision.setter + def process_group_revision(self, process_group_revision): + """ + Sets the process_group_revision of this ProcessGroupReplaceRequestEntity. + The revision for the Process Group being updated. + + :param process_group_revision: The process_group_revision of this ProcessGroupReplaceRequestEntity. + :type: RevisionDTO + """ + + self._process_group_revision = process_group_revision + + @property + def request(self): + """ + Gets the request of this ProcessGroupReplaceRequestEntity. + The Process Group Change Request + + :return: The request of this ProcessGroupReplaceRequestEntity. + :rtype: ProcessGroupReplaceRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this ProcessGroupReplaceRequestEntity. + The Process Group Change Request + + :param request: The request of this ProcessGroupReplaceRequestEntity. + :type: ProcessGroupReplaceRequestDTO + """ + + self._request = request + + @property + def versioned_flow_snapshot(self): + """ + Gets the versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. + Returns the Versioned Flow to replace with + + :return: The versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. + :rtype: VersionedFlowSnapshot + """ + return self._versioned_flow_snapshot + + @versioned_flow_snapshot.setter + def versioned_flow_snapshot(self, versioned_flow_snapshot): + """ + Sets the versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. + Returns the Versioned Flow to replace with + + :param versioned_flow_snapshot: The versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity. + :type: VersionedFlowSnapshot + """ + + self._versioned_flow_snapshot = versioned_flow_snapshot + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessGroupReplaceRequestEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/process_group_status_dto.py b/nipyapi/nifi/models/process_group_status_dto.py index 4d6b1eec..7e6e2fd9 100644 --- a/nipyapi/nifi/models/process_group_status_dto.py +++ b/nipyapi/nifi/models/process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_entity.py b/nipyapi/nifi/models/process_group_status_entity.py index 322f4cc2..b8fbef8a 100644 --- a/nipyapi/nifi/models/process_group_status_entity.py +++ b/nipyapi/nifi/models/process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_dto.py b/nipyapi/nifi/models/process_group_status_snapshot_dto.py index 858af104..2818444f 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_entity.py b/nipyapi/nifi/models/process_group_status_snapshot_entity.py index b07a66b3..04545505 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_groups_entity.py b/nipyapi/nifi/models/process_groups_entity.py index c4d8aaeb..1c6bb556 100644 --- a/nipyapi/nifi/models/process_groups_entity.py +++ b/nipyapi/nifi/models/process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_config_dto.py b/nipyapi/nifi/models/processor_config_dto.py index 33e6fa7c..d46656d3 100644 --- a/nipyapi/nifi/models/processor_config_dto.py +++ b/nipyapi/nifi/models/processor_config_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_dto.py b/nipyapi/nifi/models/processor_dto.py index 1479a482..77bd53c3 100644 --- a/nipyapi/nifi/models/processor_dto.py +++ b/nipyapi/nifi/models/processor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_entity.py b/nipyapi/nifi/models/processor_entity.py index f5f97e72..17e5584b 100644 --- a/nipyapi/nifi/models/processor_entity.py +++ b/nipyapi/nifi/models/processor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_run_status_details_dto.py b/nipyapi/nifi/models/processor_run_status_details_dto.py new file mode 100644 index 00000000..e82f74bc --- /dev/null +++ b/nipyapi/nifi/models/processor_run_status_details_dto.py @@ -0,0 +1,243 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessorRunStatusDetailsDTO(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'name': 'str', + 'run_status': 'str', + 'validation_errors': 'list[str]', + 'active_thread_count': 'int' + } + + attribute_map = { + 'id': 'id', + 'name': 'name', + 'run_status': 'runStatus', + 'validation_errors': 'validationErrors', + 'active_thread_count': 'activeThreadCount' + } + + def __init__(self, id=None, name=None, run_status=None, validation_errors=None, active_thread_count=None): + """ + ProcessorRunStatusDetailsDTO - a model defined in Swagger + """ + + self._id = None + self._name = None + self._run_status = None + self._validation_errors = None + self._active_thread_count = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + if run_status is not None: + self.run_status = run_status + if validation_errors is not None: + self.validation_errors = validation_errors + if active_thread_count is not None: + self.active_thread_count = active_thread_count + + @property + def id(self): + """ + Gets the id of this ProcessorRunStatusDetailsDTO. + The ID of the processor + + :return: The id of this ProcessorRunStatusDetailsDTO. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this ProcessorRunStatusDetailsDTO. + The ID of the processor + + :param id: The id of this ProcessorRunStatusDetailsDTO. + :type: str + """ + + self._id = id + + @property + def name(self): + """ + Gets the name of this ProcessorRunStatusDetailsDTO. + The name of the processor + + :return: The name of this ProcessorRunStatusDetailsDTO. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this ProcessorRunStatusDetailsDTO. + The name of the processor + + :param name: The name of this ProcessorRunStatusDetailsDTO. + :type: str + """ + + self._name = name + + @property + def run_status(self): + """ + Gets the run_status of this ProcessorRunStatusDetailsDTO. + The run status of the processor + + :return: The run_status of this ProcessorRunStatusDetailsDTO. + :rtype: str + """ + return self._run_status + + @run_status.setter + def run_status(self, run_status): + """ + Sets the run_status of this ProcessorRunStatusDetailsDTO. + The run status of the processor + + :param run_status: The run_status of this ProcessorRunStatusDetailsDTO. + :type: str + """ + allowed_values = ["Running", "Stopped", "Invalid", "Validating", "Disabled"] + if run_status not in allowed_values: + raise ValueError( + "Invalid value for `run_status` ({0}), must be one of {1}" + .format(run_status, allowed_values) + ) + + self._run_status = run_status + + @property + def validation_errors(self): + """ + Gets the validation_errors of this ProcessorRunStatusDetailsDTO. + The processor's validation errors + + :return: The validation_errors of this ProcessorRunStatusDetailsDTO. + :rtype: list[str] + """ + return self._validation_errors + + @validation_errors.setter + def validation_errors(self, validation_errors): + """ + Sets the validation_errors of this ProcessorRunStatusDetailsDTO. + The processor's validation errors + + :param validation_errors: The validation_errors of this ProcessorRunStatusDetailsDTO. + :type: list[str] + """ + + self._validation_errors = validation_errors + + @property + def active_thread_count(self): + """ + Gets the active_thread_count of this ProcessorRunStatusDetailsDTO. + The current number of threads that the processor is currently using + + :return: The active_thread_count of this ProcessorRunStatusDetailsDTO. + :rtype: int + """ + return self._active_thread_count + + @active_thread_count.setter + def active_thread_count(self, active_thread_count): + """ + Sets the active_thread_count of this ProcessorRunStatusDetailsDTO. + The current number of threads that the processor is currently using + + :param active_thread_count: The active_thread_count of this ProcessorRunStatusDetailsDTO. + :type: int + """ + + self._active_thread_count = active_thread_count + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessorRunStatusDetailsDTO): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/processor_run_status_details_entity.py b/nipyapi/nifi/models/processor_run_status_details_entity.py new file mode 100644 index 00000000..c8341e35 --- /dev/null +++ b/nipyapi/nifi/models/processor_run_status_details_entity.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessorRunStatusDetailsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'revision': 'RevisionDTO', + 'permissions': 'PermissionsDTO', + 'run_status_details': 'ProcessorRunStatusDetailsDTO' + } + + attribute_map = { + 'revision': 'revision', + 'permissions': 'permissions', + 'run_status_details': 'runStatusDetails' + } + + def __init__(self, revision=None, permissions=None, run_status_details=None): + """ + ProcessorRunStatusDetailsEntity - a model defined in Swagger + """ + + self._revision = None + self._permissions = None + self._run_status_details = None + + if revision is not None: + self.revision = revision + if permissions is not None: + self.permissions = permissions + if run_status_details is not None: + self.run_status_details = run_status_details + + @property + def revision(self): + """ + Gets the revision of this ProcessorRunStatusDetailsEntity. + The revision for the Processor. + + :return: The revision of this ProcessorRunStatusDetailsEntity. + :rtype: RevisionDTO + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this ProcessorRunStatusDetailsEntity. + The revision for the Processor. + + :param revision: The revision of this ProcessorRunStatusDetailsEntity. + :type: RevisionDTO + """ + + self._revision = revision + + @property + def permissions(self): + """ + Gets the permissions of this ProcessorRunStatusDetailsEntity. + The permissions for the Processor. + + :return: The permissions of this ProcessorRunStatusDetailsEntity. + :rtype: PermissionsDTO + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """ + Sets the permissions of this ProcessorRunStatusDetailsEntity. + The permissions for the Processor. + + :param permissions: The permissions of this ProcessorRunStatusDetailsEntity. + :type: PermissionsDTO + """ + + self._permissions = permissions + + @property + def run_status_details(self): + """ + Gets the run_status_details of this ProcessorRunStatusDetailsEntity. + The details of a Processor's run status + + :return: The run_status_details of this ProcessorRunStatusDetailsEntity. + :rtype: ProcessorRunStatusDetailsDTO + """ + return self._run_status_details + + @run_status_details.setter + def run_status_details(self, run_status_details): + """ + Sets the run_status_details of this ProcessorRunStatusDetailsEntity. + The details of a Processor's run status + + :param run_status_details: The run_status_details of this ProcessorRunStatusDetailsEntity. + :type: ProcessorRunStatusDetailsDTO + """ + + self._run_status_details = run_status_details + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessorRunStatusDetailsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/processor_run_status_entity.py b/nipyapi/nifi/models/processor_run_status_entity.py index 663ea33d..14f76acf 100644 --- a/nipyapi/nifi/models/processor_run_status_entity.py +++ b/nipyapi/nifi/models/processor_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_dto.py b/nipyapi/nifi/models/processor_status_dto.py index f395b084..905bd71f 100644 --- a/nipyapi/nifi/models/processor_status_dto.py +++ b/nipyapi/nifi/models/processor_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_entity.py b/nipyapi/nifi/models/processor_status_entity.py index dfb9b0f1..c9a9a116 100644 --- a/nipyapi/nifi/models/processor_status_entity.py +++ b/nipyapi/nifi/models/processor_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_dto.py b/nipyapi/nifi/models/processor_status_snapshot_dto.py index 679d208d..d7b81a6f 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_entity.py b/nipyapi/nifi/models/processor_status_snapshot_entity.py index d6d9440f..e0bfbe87 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_entity.py +++ b/nipyapi/nifi/models/processor_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_types_entity.py b/nipyapi/nifi/models/processor_types_entity.py index 54a8fb0d..11b49747 100644 --- a/nipyapi/nifi/models/processor_types_entity.py +++ b/nipyapi/nifi/models/processor_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processors_entity.py b/nipyapi/nifi/models/processors_entity.py index d4502703..c9054738 100644 --- a/nipyapi/nifi/models/processors_entity.py +++ b/nipyapi/nifi/models/processors_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processors_run_status_details_entity.py b/nipyapi/nifi/models/processors_run_status_details_entity.py new file mode 100644 index 00000000..8256aea6 --- /dev/null +++ b/nipyapi/nifi/models/processors_run_status_details_entity.py @@ -0,0 +1,123 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class ProcessorsRunStatusDetailsEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'run_status_details': 'list[ProcessorRunStatusDetailsEntity]' + } + + attribute_map = { + 'run_status_details': 'runStatusDetails' + } + + def __init__(self, run_status_details=None): + """ + ProcessorsRunStatusDetailsEntity - a model defined in Swagger + """ + + self._run_status_details = None + + if run_status_details is not None: + self.run_status_details = run_status_details + + @property + def run_status_details(self): + """ + Gets the run_status_details of this ProcessorsRunStatusDetailsEntity. + + :return: The run_status_details of this ProcessorsRunStatusDetailsEntity. + :rtype: list[ProcessorRunStatusDetailsEntity] + """ + return self._run_status_details + + @run_status_details.setter + def run_status_details(self, run_status_details): + """ + Sets the run_status_details of this ProcessorsRunStatusDetailsEntity. + + :param run_status_details: The run_status_details of this ProcessorsRunStatusDetailsEntity. + :type: list[ProcessorRunStatusDetailsEntity] + """ + + self._run_status_details = run_status_details + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, ProcessorsRunStatusDetailsEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/property_descriptor_dto.py b/nipyapi/nifi/models/property_descriptor_dto.py index 21f70dec..c09157f9 100644 --- a/nipyapi/nifi/models/property_descriptor_dto.py +++ b/nipyapi/nifi/models/property_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_entity.py b/nipyapi/nifi/models/property_descriptor_entity.py index 9b5c2cce..f2bebaca 100644 --- a/nipyapi/nifi/models/property_descriptor_entity.py +++ b/nipyapi/nifi/models/property_descriptor_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_history_dto.py b/nipyapi/nifi/models/property_history_dto.py index 0b8476b2..517756b7 100644 --- a/nipyapi/nifi/models/property_history_dto.py +++ b/nipyapi/nifi/models/property_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_dto.py b/nipyapi/nifi/models/provenance_dto.py index 171ad45d..f8dcd06b 100644 --- a/nipyapi/nifi/models/provenance_dto.py +++ b/nipyapi/nifi/models/provenance_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_entity.py b/nipyapi/nifi/models/provenance_entity.py index 0e8a323e..1d6ef00f 100644 --- a/nipyapi/nifi/models/provenance_entity.py +++ b/nipyapi/nifi/models/provenance_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_dto.py b/nipyapi/nifi/models/provenance_event_dto.py index e8da3df0..3afb606b 100644 --- a/nipyapi/nifi/models/provenance_event_dto.py +++ b/nipyapi/nifi/models/provenance_event_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_entity.py b/nipyapi/nifi/models/provenance_event_entity.py index d5af4c68..c8043a3e 100644 --- a/nipyapi/nifi/models/provenance_event_entity.py +++ b/nipyapi/nifi/models/provenance_event_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_link_dto.py b/nipyapi/nifi/models/provenance_link_dto.py index 2ca1f868..5d11d7de 100644 --- a/nipyapi/nifi/models/provenance_link_dto.py +++ b/nipyapi/nifi/models/provenance_link_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_node_dto.py b/nipyapi/nifi/models/provenance_node_dto.py index 32bf2409..01b2e2e6 100644 --- a/nipyapi/nifi/models/provenance_node_dto.py +++ b/nipyapi/nifi/models/provenance_node_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_dto.py b/nipyapi/nifi/models/provenance_options_dto.py index 2ecb5890..c2cd53bf 100644 --- a/nipyapi/nifi/models/provenance_options_dto.py +++ b/nipyapi/nifi/models/provenance_options_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_entity.py b/nipyapi/nifi/models/provenance_options_entity.py index e78c0449..b9311e8d 100644 --- a/nipyapi/nifi/models/provenance_options_entity.py +++ b/nipyapi/nifi/models/provenance_options_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_request_dto.py b/nipyapi/nifi/models/provenance_request_dto.py index 648e75e5..c9c0ec4e 100644 --- a/nipyapi/nifi/models/provenance_request_dto.py +++ b/nipyapi/nifi/models/provenance_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_results_dto.py b/nipyapi/nifi/models/provenance_results_dto.py index 993db53f..5a95b089 100644 --- a/nipyapi/nifi/models/provenance_results_dto.py +++ b/nipyapi/nifi/models/provenance_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_searchable_field_dto.py b/nipyapi/nifi/models/provenance_searchable_field_dto.py index bcde8585..feafc36a 100644 --- a/nipyapi/nifi/models/provenance_searchable_field_dto.py +++ b/nipyapi/nifi/models/provenance_searchable_field_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/queue_size_dto.py b/nipyapi/nifi/models/queue_size_dto.py index d9c4e760..a1bc13b9 100644 --- a/nipyapi/nifi/models/queue_size_dto.py +++ b/nipyapi/nifi/models/queue_size_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_client_entity.py b/nipyapi/nifi/models/registry_client_entity.py index 04e5cb3a..48a31eaa 100644 --- a/nipyapi/nifi/models/registry_client_entity.py +++ b/nipyapi/nifi/models/registry_client_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_clients_entity.py b/nipyapi/nifi/models/registry_clients_entity.py index 6f3b99ba..f85e318f 100644 --- a/nipyapi/nifi/models/registry_clients_entity.py +++ b/nipyapi/nifi/models/registry_clients_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registry_dto.py b/nipyapi/nifi/models/registry_dto.py index f410c1a9..90e06fd0 100644 --- a/nipyapi/nifi/models/registry_dto.py +++ b/nipyapi/nifi/models/registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/relationship_dto.py b/nipyapi/nifi/models/relationship_dto.py index f14c340e..5b3c772f 100644 --- a/nipyapi/nifi/models/relationship_dto.py +++ b/nipyapi/nifi/models/relationship_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_port_run_status_entity.py b/nipyapi/nifi/models/remote_port_run_status_entity.py index e42773cf..87811acc 100644 --- a/nipyapi/nifi/models/remote_port_run_status_entity.py +++ b/nipyapi/nifi/models/remote_port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_contents_dto.py b/nipyapi/nifi/models/remote_process_group_contents_dto.py index ce115c28..7ccdb17b 100644 --- a/nipyapi/nifi/models/remote_process_group_contents_dto.py +++ b/nipyapi/nifi/models/remote_process_group_contents_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_dto.py b/nipyapi/nifi/models/remote_process_group_dto.py index 454be072..2a232f8e 100644 --- a/nipyapi/nifi/models/remote_process_group_dto.py +++ b/nipyapi/nifi/models/remote_process_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_entity.py b/nipyapi/nifi/models/remote_process_group_entity.py index 8829bcbe..7858b56d 100644 --- a/nipyapi/nifi/models/remote_process_group_entity.py +++ b/nipyapi/nifi/models/remote_process_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_dto.py b/nipyapi/nifi/models/remote_process_group_port_dto.py index 314d1057..c91682fb 100644 --- a/nipyapi/nifi/models/remote_process_group_port_dto.py +++ b/nipyapi/nifi/models/remote_process_group_port_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_entity.py b/nipyapi/nifi/models/remote_process_group_port_entity.py index 824cf405..01c27547 100644 --- a/nipyapi/nifi/models/remote_process_group_port_entity.py +++ b/nipyapi/nifi/models/remote_process_group_port_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_dto.py b/nipyapi/nifi/models/remote_process_group_status_dto.py index 8d479b82..effd0b0f 100644 --- a/nipyapi/nifi/models/remote_process_group_status_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_entity.py b/nipyapi/nifi/models/remote_process_group_status_entity.py index 882ea5c4..61a6041f 100644 --- a/nipyapi/nifi/models/remote_process_group_status_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py index 9b3052a1..19d2043b 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py index 9bd628dd..9954d04a 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_groups_entity.py b/nipyapi/nifi/models/remote_process_groups_entity.py index 6d37ee7a..f31287a0 100644 --- a/nipyapi/nifi/models/remote_process_groups_entity.py +++ b/nipyapi/nifi/models/remote_process_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_dto.py b/nipyapi/nifi/models/reporting_task_dto.py index 49619df3..94ed985b 100644 --- a/nipyapi/nifi/models/reporting_task_dto.py +++ b/nipyapi/nifi/models/reporting_task_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_entity.py b/nipyapi/nifi/models/reporting_task_entity.py index 655ddaaa..ea29e562 100644 --- a/nipyapi/nifi/models/reporting_task_entity.py +++ b/nipyapi/nifi/models/reporting_task_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_run_status_entity.py b/nipyapi/nifi/models/reporting_task_run_status_entity.py index 0400ce9b..41b6eb3e 100644 --- a/nipyapi/nifi/models/reporting_task_run_status_entity.py +++ b/nipyapi/nifi/models/reporting_task_run_status_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_status_dto.py b/nipyapi/nifi/models/reporting_task_status_dto.py index ed2b12cd..80e11f73 100644 --- a/nipyapi/nifi/models/reporting_task_status_dto.py +++ b/nipyapi/nifi/models/reporting_task_status_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_types_entity.py b/nipyapi/nifi/models/reporting_task_types_entity.py index 38463924..ec12b78e 100644 --- a/nipyapi/nifi/models/reporting_task_types_entity.py +++ b/nipyapi/nifi/models/reporting_task_types_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_tasks_entity.py b/nipyapi/nifi/models/reporting_tasks_entity.py index bb3ba932..0957f295 100644 --- a/nipyapi/nifi/models/reporting_tasks_entity.py +++ b/nipyapi/nifi/models/reporting_tasks_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/required_permission_dto.py b/nipyapi/nifi/models/required_permission_dto.py index ba4a0bcd..1c4e2be3 100644 --- a/nipyapi/nifi/models/required_permission_dto.py +++ b/nipyapi/nifi/models/required_permission_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resource_dto.py b/nipyapi/nifi/models/resource_dto.py index 1c7a28d2..65e4c5fd 100644 --- a/nipyapi/nifi/models/resource_dto.py +++ b/nipyapi/nifi/models/resource_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resources_entity.py b/nipyapi/nifi/models/resources_entity.py index a8635a05..875cd75f 100644 --- a/nipyapi/nifi/models/resources_entity.py +++ b/nipyapi/nifi/models/resources_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/revision_dto.py b/nipyapi/nifi/models/revision_dto.py index 2d22bcde..ef1a88ee 100644 --- a/nipyapi/nifi/models/revision_dto.py +++ b/nipyapi/nifi/models/revision_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/revision_info.py b/nipyapi/nifi/models/revision_info.py new file mode 100644 index 00000000..e13dd158 --- /dev/null +++ b/nipyapi/nifi/models/revision_info.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class RevisionInfo(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'client_id': 'str', + 'version': 'int', + 'last_modifier': 'str' + } + + attribute_map = { + 'client_id': 'clientId', + 'version': 'version', + 'last_modifier': 'lastModifier' + } + + def __init__(self, client_id=None, version=None, last_modifier=None): + """ + RevisionInfo - a model defined in Swagger + """ + + self._client_id = None + self._version = None + self._last_modifier = None + + if client_id is not None: + self.client_id = client_id + if version is not None: + self.version = version + if last_modifier is not None: + self.last_modifier = last_modifier + + @property + def client_id(self): + """ + Gets the client_id of this RevisionInfo. + 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. + + :return: The client_id of this RevisionInfo. + :rtype: str + """ + return self._client_id + + @client_id.setter + def client_id(self, client_id): + """ + Sets the client_id of this RevisionInfo. + 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. + + :param client_id: The client_id of this RevisionInfo. + :type: str + """ + + self._client_id = client_id + + @property + def version(self): + """ + Gets the version of this RevisionInfo. + NiFi Registry 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. + + :return: The version of this RevisionInfo. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this RevisionInfo. + NiFi Registry 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. + + :param version: The version of this RevisionInfo. + :type: int + """ + + self._version = version + + @property + def last_modifier(self): + """ + Gets the last_modifier of this RevisionInfo. + The user that last modified the entity. + + :return: The last_modifier of this RevisionInfo. + :rtype: str + """ + return self._last_modifier + + @last_modifier.setter + def last_modifier(self, last_modifier): + """ + Sets the last_modifier of this RevisionInfo. + The user that last modified the entity. + + :param last_modifier: The last_modifier of this RevisionInfo. + :type: str + """ + + self._last_modifier = last_modifier + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, RevisionInfo): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/run_status_details_request_entity.py b/nipyapi/nifi/models/run_status_details_request_entity.py new file mode 100644 index 00000000..f169b791 --- /dev/null +++ b/nipyapi/nifi/models/run_status_details_request_entity.py @@ -0,0 +1,125 @@ +# coding: utf-8 + +""" + NiFi Rest Api + + The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.12.1 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class RunStatusDetailsRequestEntity(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'processor_ids': 'list[str]' + } + + attribute_map = { + 'processor_ids': 'processorIds' + } + + def __init__(self, processor_ids=None): + """ + RunStatusDetailsRequestEntity - a model defined in Swagger + """ + + self._processor_ids = None + + if processor_ids is not None: + self.processor_ids = processor_ids + + @property + def processor_ids(self): + """ + Gets the processor_ids of this RunStatusDetailsRequestEntity. + The IDs of all processors whose run status details should be provided + + :return: The processor_ids of this RunStatusDetailsRequestEntity. + :rtype: list[str] + """ + return self._processor_ids + + @processor_ids.setter + def processor_ids(self, processor_ids): + """ + Sets the processor_ids of this RunStatusDetailsRequestEntity. + The IDs of all processors whose run status details should be provided + + :param processor_ids: The processor_ids of this RunStatusDetailsRequestEntity. + :type: list[str] + """ + + self._processor_ids = processor_ids + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, RunStatusDetailsRequestEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/schedule_components_entity.py b/nipyapi/nifi/models/schedule_components_entity.py index 233289b1..6fed9071 100644 --- a/nipyapi/nifi/models/schedule_components_entity.py +++ b/nipyapi/nifi/models/schedule_components_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_result_group_dto.py b/nipyapi/nifi/models/search_result_group_dto.py index 630ea168..9f278d71 100644 --- a/nipyapi/nifi/models/search_result_group_dto.py +++ b/nipyapi/nifi/models/search_result_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_results_dto.py b/nipyapi/nifi/models/search_results_dto.py index a7c70d46..9ace5627 100644 --- a/nipyapi/nifi/models/search_results_dto.py +++ b/nipyapi/nifi/models/search_results_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,6 +38,8 @@ class SearchResultsDTO(object): 'output_port_results': 'list[ComponentSearchResultDTO]', 'remote_process_group_results': 'list[ComponentSearchResultDTO]', 'funnel_results': 'list[ComponentSearchResultDTO]', + 'label_results': 'list[ComponentSearchResultDTO]', + 'controller_service_node_results': 'list[ComponentSearchResultDTO]', 'parameter_context_results': 'list[ComponentSearchResultDTO]', 'parameter_results': 'list[ComponentSearchResultDTO]' } @@ -50,11 +52,13 @@ class SearchResultsDTO(object): 'output_port_results': 'outputPortResults', 'remote_process_group_results': 'remoteProcessGroupResults', 'funnel_results': 'funnelResults', + 'label_results': 'labelResults', + 'controller_service_node_results': 'controllerServiceNodeResults', 'parameter_context_results': 'parameterContextResults', 'parameter_results': 'parameterResults' } - def __init__(self, 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, parameter_context_results=None, parameter_results=None): + def __init__(self, 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): """ SearchResultsDTO - a model defined in Swagger """ @@ -66,6 +70,8 @@ def __init__(self, processor_results=None, connection_results=None, process_grou self._output_port_results = None self._remote_process_group_results = None self._funnel_results = None + self._label_results = None + self._controller_service_node_results = None self._parameter_context_results = None self._parameter_results = None @@ -83,6 +89,10 @@ def __init__(self, processor_results=None, connection_results=None, process_grou self.remote_process_group_results = remote_process_group_results if funnel_results is not None: self.funnel_results = funnel_results + if label_results is not None: + self.label_results = label_results + if controller_service_node_results is not None: + self.controller_service_node_results = controller_service_node_results if parameter_context_results is not None: self.parameter_context_results = parameter_context_results if parameter_results is not None: @@ -249,6 +259,52 @@ def funnel_results(self, funnel_results): self._funnel_results = funnel_results + @property + def label_results(self): + """ + Gets the label_results of this SearchResultsDTO. + The labels that matched the search. + + :return: The label_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._label_results + + @label_results.setter + def label_results(self, label_results): + """ + Sets the label_results of this SearchResultsDTO. + The labels that matched the search. + + :param label_results: The label_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._label_results = label_results + + @property + def controller_service_node_results(self): + """ + Gets the controller_service_node_results of this SearchResultsDTO. + The controller service nodes that matched the search + + :return: The controller_service_node_results of this SearchResultsDTO. + :rtype: list[ComponentSearchResultDTO] + """ + return self._controller_service_node_results + + @controller_service_node_results.setter + def controller_service_node_results(self, controller_service_node_results): + """ + Sets the controller_service_node_results of this SearchResultsDTO. + The controller service nodes that matched the search + + :param controller_service_node_results: The controller_service_node_results of this SearchResultsDTO. + :type: list[ComponentSearchResultDTO] + """ + + self._controller_service_node_results = controller_service_node_results + @property def parameter_context_results(self): """ diff --git a/nipyapi/nifi/models/search_results_entity.py b/nipyapi/nifi/models/search_results_entity.py index 7773420e..0554bad9 100644 --- a/nipyapi/nifi/models/search_results_entity.py +++ b/nipyapi/nifi/models/search_results_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_dto.py b/nipyapi/nifi/models/snippet_dto.py index 085166c3..54892736 100644 --- a/nipyapi/nifi/models/snippet_dto.py +++ b/nipyapi/nifi/models/snippet_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_entity.py b/nipyapi/nifi/models/snippet_entity.py index fefec194..66434e7a 100644 --- a/nipyapi/nifi/models/snippet_entity.py +++ b/nipyapi/nifi/models/snippet_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/start_version_control_request_entity.py b/nipyapi/nifi/models/start_version_control_request_entity.py index 926c1425..4c8bffc2 100644 --- a/nipyapi/nifi/models/start_version_control_request_entity.py +++ b/nipyapi/nifi/models/start_version_control_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_entry_dto.py b/nipyapi/nifi/models/state_entry_dto.py index 2310596e..a4a6c995 100644 --- a/nipyapi/nifi/models/state_entry_dto.py +++ b/nipyapi/nifi/models/state_entry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_map_dto.py b/nipyapi/nifi/models/state_map_dto.py index 309c4494..2050c61e 100644 --- a/nipyapi/nifi/models/state_map_dto.py +++ b/nipyapi/nifi/models/state_map_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_descriptor_dto.py b/nipyapi/nifi/models/status_descriptor_dto.py index c125ca24..011cb40e 100644 --- a/nipyapi/nifi/models/status_descriptor_dto.py +++ b/nipyapi/nifi/models/status_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_dto.py b/nipyapi/nifi/models/status_history_dto.py index 2d2ac6ec..4f0da1d4 100644 --- a/nipyapi/nifi/models/status_history_dto.py +++ b/nipyapi/nifi/models/status_history_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_entity.py b/nipyapi/nifi/models/status_history_entity.py index 2f22a918..37272441 100644 --- a/nipyapi/nifi/models/status_history_entity.py +++ b/nipyapi/nifi/models/status_history_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_snapshot_dto.py b/nipyapi/nifi/models/status_snapshot_dto.py index d1cf256b..75d67011 100644 --- a/nipyapi/nifi/models/status_snapshot_dto.py +++ b/nipyapi/nifi/models/status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/storage_usage_dto.py b/nipyapi/nifi/models/storage_usage_dto.py index 579f826a..baf37197 100644 --- a/nipyapi/nifi/models/storage_usage_dto.py +++ b/nipyapi/nifi/models/storage_usage_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/streaming_output.py b/nipyapi/nifi/models/streaming_output.py index 3d15d59e..46eea9c1 100644 --- a/nipyapi/nifi/models/streaming_output.py +++ b/nipyapi/nifi/models/streaming_output.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,11 +31,11 @@ class StreamingOutput(object): and the value is json key in definition. """ swagger_types = { - + } attribute_map = { - + } def __init__(self): diff --git a/nipyapi/nifi/models/submit_replay_request_entity.py b/nipyapi/nifi/models/submit_replay_request_entity.py index 888668b1..cd35bcc3 100644 --- a/nipyapi/nifi/models/submit_replay_request_entity.py +++ b/nipyapi/nifi/models/submit_replay_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_dto.py b/nipyapi/nifi/models/system_diagnostics_dto.py index 17e5c2a0..f079c622 100644 --- a/nipyapi/nifi/models/system_diagnostics_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_entity.py b/nipyapi/nifi/models/system_diagnostics_entity.py index 6ac10735..07527a93 100644 --- a/nipyapi/nifi/models/system_diagnostics_entity.py +++ b/nipyapi/nifi/models/system_diagnostics_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py index e6e5b323..1cdcb764 100644 --- a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_dto.py b/nipyapi/nifi/models/template_dto.py index 3a8cb53e..11f41810 100644 --- a/nipyapi/nifi/models/template_dto.py +++ b/nipyapi/nifi/models/template_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_entity.py b/nipyapi/nifi/models/template_entity.py index 157afe8c..5fbec20e 100644 --- a/nipyapi/nifi/models/template_entity.py +++ b/nipyapi/nifi/models/template_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/templates_entity.py b/nipyapi/nifi/models/templates_entity.py index 8b09419a..0861ab08 100644 --- a/nipyapi/nifi/models/templates_entity.py +++ b/nipyapi/nifi/models/templates_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_dto.py b/nipyapi/nifi/models/tenant_dto.py index bf9314cd..675ad0a4 100644 --- a/nipyapi/nifi/models/tenant_dto.py +++ b/nipyapi/nifi/models/tenant_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_entity.py b/nipyapi/nifi/models/tenant_entity.py index 6d0fb464..ebd77bcf 100644 --- a/nipyapi/nifi/models/tenant_entity.py +++ b/nipyapi/nifi/models/tenant_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenants_entity.py b/nipyapi/nifi/models/tenants_entity.py index 559d825c..68e93fb0 100644 --- a/nipyapi/nifi/models/tenants_entity.py +++ b/nipyapi/nifi/models/tenants_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/transaction_result_entity.py b/nipyapi/nifi/models/transaction_result_entity.py index 4507252e..2cf247b1 100644 --- a/nipyapi/nifi/models/transaction_result_entity.py +++ b/nipyapi/nifi/models/transaction_result_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py index e2c25399..cd19d3fb 100644 --- a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py +++ b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_dto.py b/nipyapi/nifi/models/user_dto.py index e5ab8579..f79d7150 100644 --- a/nipyapi/nifi/models/user_dto.py +++ b/nipyapi/nifi/models/user_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_entity.py b/nipyapi/nifi/models/user_entity.py index 868715a2..edde1774 100644 --- a/nipyapi/nifi/models/user_entity.py +++ b/nipyapi/nifi/models/user_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_dto.py b/nipyapi/nifi/models/user_group_dto.py index e6b9053d..79b2eeeb 100644 --- a/nipyapi/nifi/models/user_group_dto.py +++ b/nipyapi/nifi/models/user_group_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_entity.py b/nipyapi/nifi/models/user_group_entity.py index e92f8b1a..97f0cacc 100644 --- a/nipyapi/nifi/models/user_group_entity.py +++ b/nipyapi/nifi/models/user_group_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_groups_entity.py b/nipyapi/nifi/models/user_groups_entity.py index 52fb0f93..037083c0 100644 --- a/nipyapi/nifi/models/user_groups_entity.py +++ b/nipyapi/nifi/models/user_groups_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/users_entity.py b/nipyapi/nifi/models/users_entity.py index 0d838be9..d7f45875 100644 --- a/nipyapi/nifi/models/users_entity.py +++ b/nipyapi/nifi/models/users_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_dto.py b/nipyapi/nifi/models/variable_dto.py index 292b5c98..09ce7fe7 100644 --- a/nipyapi/nifi/models/variable_dto.py +++ b/nipyapi/nifi/models/variable_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_entity.py b/nipyapi/nifi/models/variable_entity.py index 0e604a84..8d48aa8f 100644 --- a/nipyapi/nifi/models/variable_entity.py +++ b/nipyapi/nifi/models/variable_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_dto.py b/nipyapi/nifi/models/variable_registry_dto.py index 04ccc099..c2686226 100644 --- a/nipyapi/nifi/models/variable_registry_dto.py +++ b/nipyapi/nifi/models/variable_registry_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_entity.py b/nipyapi/nifi/models/variable_registry_entity.py index 98b13113..6227acc4 100644 --- a/nipyapi/nifi/models/variable_registry_entity.py +++ b/nipyapi/nifi/models/variable_registry_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_dto.py b/nipyapi/nifi/models/variable_registry_update_request_dto.py index 1c2d3fd9..23fc85fc 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_entity.py b/nipyapi/nifi/models/variable_registry_update_request_entity.py index 293fb2fb..03e2211f 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_entity.py +++ b/nipyapi/nifi/models/variable_registry_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_step_dto.py b/nipyapi/nifi/models/variable_registry_update_step_dto.py index aa655549..e5b77607 100644 --- a/nipyapi/nifi/models/variable_registry_update_step_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_step_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_component_mapping_entity.py b/nipyapi/nifi/models/version_control_component_mapping_entity.py index 1aa88c17..c60bbdaa 100644 --- a/nipyapi/nifi/models/version_control_component_mapping_entity.py +++ b/nipyapi/nifi/models/version_control_component_mapping_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_dto.py b/nipyapi/nifi/models/version_control_information_dto.py index f75d5abf..e7e087b8 100644 --- a/nipyapi/nifi/models/version_control_information_dto.py +++ b/nipyapi/nifi/models/version_control_information_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_entity.py b/nipyapi/nifi/models/version_control_information_entity.py index b40b9361..7ea4dc08 100644 --- a/nipyapi/nifi/models/version_control_information_entity.py +++ b/nipyapi/nifi/models/version_control_information_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,55 +31,32 @@ class VersionControlInformationEntity(object): and the value is json key in definition. """ swagger_types = { - 'version_control_information': 'VersionControlInformationDTO', 'process_group_revision': 'RevisionDTO', - 'disconnected_node_acknowledged': 'bool' + 'disconnected_node_acknowledged': 'bool', + 'version_control_information': 'VersionControlInformationDTO' } attribute_map = { - 'version_control_information': 'versionControlInformation', 'process_group_revision': 'processGroupRevision', - 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged' + 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', + 'version_control_information': 'versionControlInformation' } - def __init__(self, version_control_information=None, process_group_revision=None, disconnected_node_acknowledged=None): + def __init__(self, process_group_revision=None, disconnected_node_acknowledged=None, version_control_information=None): """ VersionControlInformationEntity - a model defined in Swagger """ - self._version_control_information = None self._process_group_revision = None self._disconnected_node_acknowledged = None + self._version_control_information = None - if version_control_information is not None: - self.version_control_information = version_control_information if process_group_revision is not None: self.process_group_revision = process_group_revision if disconnected_node_acknowledged is not None: self.disconnected_node_acknowledged = disconnected_node_acknowledged - - @property - def version_control_information(self): - """ - Gets the version_control_information of this VersionControlInformationEntity. - The Version Control information - - :return: The version_control_information of this VersionControlInformationEntity. - :rtype: VersionControlInformationDTO - """ - return self._version_control_information - - @version_control_information.setter - def version_control_information(self, version_control_information): - """ - Sets the version_control_information of this VersionControlInformationEntity. - The Version Control information - - :param version_control_information: The version_control_information of this VersionControlInformationEntity. - :type: VersionControlInformationDTO - """ - - self._version_control_information = version_control_information + if version_control_information is not None: + self.version_control_information = version_control_information @property def process_group_revision(self): @@ -127,6 +104,29 @@ def disconnected_node_acknowledged(self, disconnected_node_acknowledged): self._disconnected_node_acknowledged = disconnected_node_acknowledged + @property + def version_control_information(self): + """ + Gets the version_control_information of this VersionControlInformationEntity. + The Version Control information + + :return: The version_control_information of this VersionControlInformationEntity. + :rtype: VersionControlInformationDTO + """ + return self._version_control_information + + @version_control_information.setter + def version_control_information(self, version_control_information): + """ + Sets the version_control_information of this VersionControlInformationEntity. + The Version Control information + + :param version_control_information: The version_control_information of this VersionControlInformationEntity. + :type: VersionControlInformationDTO + """ + + self._version_control_information = version_control_information + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/version_info_dto.py b/nipyapi/nifi/models/version_info_dto.py index a75bb349..6cb60bec 100644 --- a/nipyapi/nifi/models/version_info_dto.py +++ b/nipyapi/nifi/models/version_info_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_connection.py b/nipyapi/nifi/models/versioned_connection.py index e2acce56..e451c378 100644 --- a/nipyapi/nifi/models/versioned_connection.py +++ b/nipyapi/nifi/models/versioned_connection.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_controller_service.py b/nipyapi/nifi/models/versioned_controller_service.py index 87b770fa..8a305c6d 100644 --- a/nipyapi/nifi/models/versioned_controller_service.py +++ b/nipyapi/nifi/models/versioned_controller_service.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow.py b/nipyapi/nifi/models/versioned_flow.py index a65737ce..bb466d46 100644 --- a/nipyapi/nifi/models/versioned_flow.py +++ b/nipyapi/nifi/models/versioned_flow.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,7 +41,8 @@ class VersionedFlow(object): 'modified_timestamp': 'int', 'type': 'str', 'permissions': 'Permissions', - 'version_count': 'int' + 'version_count': 'int', + 'revision': 'RevisionInfo' } attribute_map = { @@ -55,10 +56,11 @@ class VersionedFlow(object): 'modified_timestamp': 'modifiedTimestamp', 'type': 'type', 'permissions': 'permissions', - 'version_count': 'versionCount' + 'version_count': 'versionCount', + 'revision': 'revision' } - def __init__(self, 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): + def __init__(self, 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): """ VersionedFlow - a model defined in Swagger """ @@ -74,6 +76,7 @@ def __init__(self, link=None, identifier=None, name=None, description=None, buck self._type = None self._permissions = None self._version_count = None + self._revision = None if link is not None: self.link = link @@ -94,6 +97,8 @@ def __init__(self, link=None, identifier=None, name=None, description=None, buck self.permissions = permissions if version_count is not None: self.version_count = version_count + if revision is not None: + self.revision = revision @property def link(self): @@ -366,6 +371,29 @@ def version_count(self, version_count): self._version_count = version_count + @property + def revision(self): + """ + Gets the revision of this VersionedFlow. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this VersionedFlow. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this VersionedFlow. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this VersionedFlow. + :type: RevisionInfo + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_flow_coordinates.py b/nipyapi/nifi/models/versioned_flow_coordinates.py index 4ad9ce9f..c3b0648e 100644 --- a/nipyapi/nifi/models/versioned_flow_coordinates.py +++ b/nipyapi/nifi/models/versioned_flow_coordinates.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_dto.py b/nipyapi/nifi/models/versioned_flow_dto.py index 188e3259..d4205a0b 100644 --- a/nipyapi/nifi/models/versioned_flow_dto.py +++ b/nipyapi/nifi/models/versioned_flow_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_entity.py b/nipyapi/nifi/models/versioned_flow_entity.py index 77850b51..8dece449 100644 --- a/nipyapi/nifi/models/versioned_flow_entity.py +++ b/nipyapi/nifi/models/versioned_flow_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot.py b/nipyapi/nifi/models/versioned_flow_snapshot.py index 3ab9b1ca..e4cf5187 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py index 5bdbd63d..5695ae6e 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py index 81480f31..d028d9c9 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py index 913278e5..6ee12294 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py index ca7febc7..115649dc 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_dto.py b/nipyapi/nifi/models/versioned_flow_update_request_dto.py index 2c395517..2cd74318 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_dto.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_dto.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -115,7 +115,7 @@ def request_id(self, request_id): def process_group_id(self): """ Gets the process_group_id of this VersionedFlowUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to + The unique ID of the Process Group being updated :return: The process_group_id of this VersionedFlowUpdateRequestDTO. :rtype: str @@ -126,7 +126,7 @@ def process_group_id(self): def process_group_id(self, process_group_id): """ Sets the process_group_id of this VersionedFlowUpdateRequestDTO. - The unique ID of the Process Group that the variable registry belongs to + The unique ID of the Process Group being updated :param process_group_id: The process_group_id of this VersionedFlowUpdateRequestDTO. :type: str diff --git a/nipyapi/nifi/models/versioned_flow_update_request_entity.py b/nipyapi/nifi/models/versioned_flow_update_request_entity.py index c2ca0c40..fcdca15e 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_entity.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,56 +31,33 @@ class VersionedFlowUpdateRequestEntity(object): and the value is json key in definition. """ swagger_types = { - 'request': 'VersionedFlowUpdateRequestDTO', - 'process_group_revision': 'RevisionDTO' + 'process_group_revision': 'RevisionDTO', + 'request': 'VersionedFlowUpdateRequestDTO' } attribute_map = { - 'request': 'request', - 'process_group_revision': 'processGroupRevision' + 'process_group_revision': 'processGroupRevision', + 'request': 'request' } - def __init__(self, request=None, process_group_revision=None): + def __init__(self, process_group_revision=None, request=None): """ VersionedFlowUpdateRequestEntity - a model defined in Swagger """ - self._request = None self._process_group_revision = None + self._request = None - if request is not None: - self.request = request if process_group_revision is not None: self.process_group_revision = process_group_revision - - @property - def request(self): - """ - Gets the request of this VersionedFlowUpdateRequestEntity. - The Versioned Flow Update Request - - :return: The request of this VersionedFlowUpdateRequestEntity. - :rtype: VersionedFlowUpdateRequestDTO - """ - return self._request - - @request.setter - def request(self, request): - """ - Sets the request of this VersionedFlowUpdateRequestEntity. - The Versioned Flow Update Request - - :param request: The request of this VersionedFlowUpdateRequestEntity. - :type: VersionedFlowUpdateRequestDTO - """ - - self._request = request + if request is not None: + self.request = request @property def process_group_revision(self): """ Gets the process_group_revision of this VersionedFlowUpdateRequestEntity. - The revision for the Process Group that owns this variable registry. + The revision for the Process Group being updated. :return: The process_group_revision of this VersionedFlowUpdateRequestEntity. :rtype: RevisionDTO @@ -91,7 +68,7 @@ def process_group_revision(self): def process_group_revision(self, process_group_revision): """ Sets the process_group_revision of this VersionedFlowUpdateRequestEntity. - The revision for the Process Group that owns this variable registry. + The revision for the Process Group being updated. :param process_group_revision: The process_group_revision of this VersionedFlowUpdateRequestEntity. :type: RevisionDTO @@ -99,6 +76,29 @@ def process_group_revision(self, process_group_revision): self._process_group_revision = process_group_revision + @property + def request(self): + """ + Gets the request of this VersionedFlowUpdateRequestEntity. + The Flow Update Request + + :return: The request of this VersionedFlowUpdateRequestEntity. + :rtype: VersionedFlowUpdateRequestDTO + """ + return self._request + + @request.setter + def request(self, request): + """ + Sets the request of this VersionedFlowUpdateRequestEntity. + The Flow Update Request + + :param request: The request of this VersionedFlowUpdateRequestEntity. + :type: VersionedFlowUpdateRequestDTO + """ + + self._request = request + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/versioned_flows_entity.py b/nipyapi/nifi/models/versioned_flows_entity.py index 3d405860..a39b68b8 100644 --- a/nipyapi/nifi/models/versioned_flows_entity.py +++ b/nipyapi/nifi/models/versioned_flows_entity.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_funnel.py b/nipyapi/nifi/models/versioned_funnel.py index 704febf6..b5fb2377 100644 --- a/nipyapi/nifi/models/versioned_funnel.py +++ b/nipyapi/nifi/models/versioned_funnel.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_label.py b/nipyapi/nifi/models/versioned_label.py index e8c62ca3..63cb96be 100644 --- a/nipyapi/nifi/models/versioned_label.py +++ b/nipyapi/nifi/models/versioned_label.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter.py b/nipyapi/nifi/models/versioned_parameter.py index c7a3c55b..aa98b271 100644 --- a/nipyapi/nifi/models/versioned_parameter.py +++ b/nipyapi/nifi/models/versioned_parameter.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter_context.py b/nipyapi/nifi/models/versioned_parameter_context.py index 066d53f6..94a4ddbe 100644 --- a/nipyapi/nifi/models/versioned_parameter_context.py +++ b/nipyapi/nifi/models/versioned_parameter_context.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_port.py b/nipyapi/nifi/models/versioned_port.py index 44f71a28..2571dd97 100644 --- a/nipyapi/nifi/models/versioned_port.py +++ b/nipyapi/nifi/models/versioned_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_process_group.py b/nipyapi/nifi/models/versioned_process_group.py index 6eac1de0..d377c6f0 100644 --- a/nipyapi/nifi/models/versioned_process_group.py +++ b/nipyapi/nifi/models/versioned_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -47,6 +47,8 @@ class VersionedProcessGroup(object): 'versioned_flow_coordinates': 'VersionedFlowCoordinates', 'variables': 'dict(str, str)', 'parameter_context_name': 'str', + 'flow_file_concurrency': 'str', + 'flow_file_outbound_policy': 'str', 'component_type': 'str', 'group_identifier': 'str' } @@ -68,11 +70,13 @@ class VersionedProcessGroup(object): 'versioned_flow_coordinates': 'versionedFlowCoordinates', 'variables': 'variables', 'parameter_context_name': 'parameterContextName', + 'flow_file_concurrency': 'flowFileConcurrency', + 'flow_file_outbound_policy': 'flowFileOutboundPolicy', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, component_type=None, group_identifier=None): + def __init__(self, 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, flow_file_concurrency=None, flow_file_outbound_policy=None, component_type=None, group_identifier=None): """ VersionedProcessGroup - a model defined in Swagger """ @@ -93,6 +97,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self._versioned_flow_coordinates = None self._variables = None self._parameter_context_name = None + self._flow_file_concurrency = None + self._flow_file_outbound_policy = None self._component_type = None self._group_identifier = None @@ -128,6 +134,10 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self.variables = variables if parameter_context_name is not None: self.parameter_context_name = parameter_context_name + if flow_file_concurrency is not None: + self.flow_file_concurrency = flow_file_concurrency + if flow_file_outbound_policy is not None: + self.flow_file_outbound_policy = flow_file_outbound_policy if component_type is not None: self.component_type = component_type if group_identifier is not None: @@ -501,6 +511,52 @@ def parameter_context_name(self, parameter_context_name): self._parameter_context_name = parameter_context_name + @property + def flow_file_concurrency(self): + """ + Gets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group + + :return: The flow_file_concurrency of this VersionedProcessGroup. + :rtype: str + """ + return self._flow_file_concurrency + + @flow_file_concurrency.setter + def flow_file_concurrency(self, flow_file_concurrency): + """ + Sets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group + + :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. + :type: str + """ + + self._flow_file_concurrency = flow_file_concurrency + + @property + def flow_file_outbound_policy(self): + """ + Gets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group + + :return: The flow_file_outbound_policy of this VersionedProcessGroup. + :rtype: str + """ + return self._flow_file_outbound_policy + + @flow_file_outbound_policy.setter + def flow_file_outbound_policy(self, flow_file_outbound_policy): + """ + Sets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group + + :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. + :type: str + """ + + self._flow_file_outbound_policy = flow_file_outbound_policy + @property def component_type(self): """ diff --git a/nipyapi/nifi/models/versioned_processor.py b/nipyapi/nifi/models/versioned_processor.py index 8ddd94ca..5e77d1c9 100644 --- a/nipyapi/nifi/models/versioned_processor.py +++ b/nipyapi/nifi/models/versioned_processor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_property_descriptor.py b/nipyapi/nifi/models/versioned_property_descriptor.py index 6c5852c4..f4ab2ac6 100644 --- a/nipyapi/nifi/models/versioned_property_descriptor.py +++ b/nipyapi/nifi/models/versioned_property_descriptor.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_group_port.py b/nipyapi/nifi/models/versioned_remote_group_port.py index c1d13618..0754912b 100644 --- a/nipyapi/nifi/models/versioned_remote_group_port.py +++ b/nipyapi/nifi/models/versioned_remote_group_port.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_process_group.py b/nipyapi/nifi/models/versioned_remote_process_group.py index 2e9022c5..e210e78d 100644 --- a/nipyapi/nifi/models/versioned_remote_process_group.py +++ b/nipyapi/nifi/models/versioned_remote_process_group.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index 67c26e6a..a159e084 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -5,7 +5,7 @@ The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.11.1-SNAPSHOT + OpenAPI spec version: 1.12.1 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/__init__.py b/nipyapi/registry/__init__.py index 9933fcb9..089f45cc 100644 --- a/nipyapi/registry/__init__.py +++ b/nipyapi/registry/__init__.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -59,6 +59,7 @@ from .models.resource_permissions import ResourcePermissions from .models.restricted import Restricted from .models.restriction import Restriction +from .models.revision_info import RevisionInfo from .models.stateful import Stateful from .models.system_resource_consideration import SystemResourceConsideration from .models.tag_count import TagCount diff --git a/nipyapi/registry/api_client.py b/nipyapi/registry/api_client.py index 82194326..28a203d4 100644 --- a/nipyapi/registry/api_client.py +++ b/nipyapi/registry/api_client.py @@ -4,7 +4,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/access_api.py b/nipyapi/registry/apis/access_api.py index a4306e41..e3a9ca57 100644 --- a/nipyapi/registry/apis/access_api.py +++ b/nipyapi/registry/apis/access_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -121,7 +121,7 @@ def create_access_token_by_trying_all_providers_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/token', 'POST', path_params, @@ -219,7 +219,7 @@ def create_access_token_using_basic_auth_credentials_with_http_info(self, **kwar select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'BasicAuth'] + auth_settings = ['tokenAuth', 'basicAuth', 'BasicAuth'] return self.api_client.call_api('/access/token/login', 'POST', path_params, @@ -317,7 +317,7 @@ def create_access_token_using_identity_provider_credentials_with_http_info(self, select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/token/identity-provider', 'POST', path_params, @@ -415,7 +415,7 @@ def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/token/kerberos', 'POST', path_params, @@ -513,7 +513,7 @@ def get_access_status_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/access', 'GET', path_params, @@ -611,7 +611,7 @@ def get_identity_provider_usage_instructions_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/token/identity-provider/usage', 'GET', path_params, @@ -628,6 +628,104 @@ def get_identity_provider_usage_instructions_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def log_out(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.log_out_with_http_info(**kwargs) + else: + (data) = self.log_out_with_http_info(**kwargs) + return data + + def log_out_with_http_info(self, **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) + + :param callback function: The callback function + for asynchronous request. (optional) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method log_out" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['*/*']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth', 'basicAuth'] + + return self.api_client.call_api('/access/logout', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def test_identity_provider_recognizes_credentials_format(self, **kwargs): """ Test identity provider @@ -709,7 +807,7 @@ def test_identity_provider_recognizes_credentials_format_with_http_info(self, ** select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth'] + auth_settings = ['tokenAuth', 'basicAuth'] return self.api_client.call_api('/access/token/identity-provider/test', 'POST', path_params, diff --git a/nipyapi/registry/apis/bucket_bundles_api.py b/nipyapi/registry/apis/bucket_bundles_api.py index fc01e64a..19a8aaea 100644 --- a/nipyapi/registry/apis/bucket_bundles_api.py +++ b/nipyapi/registry/apis/bucket_bundles_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -136,7 +136,7 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, select_header_content_type(['multipart/form-data']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/bundles/{bundleType}', 'POST', path_params, @@ -242,7 +242,7 @@ def get_extension_bundles_with_http_info(self, bucket_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/bundles', 'GET', path_params, diff --git a/nipyapi/registry/apis/bucket_flows_api.py b/nipyapi/registry/apis/bucket_flows_api.py index e2717fd4..04095306 100644 --- a/nipyapi/registry/apis/bucket_flows_api.py +++ b/nipyapi/registry/apis/bucket_flows_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -136,7 +136,7 @@ def create_flow_with_http_info(self, bucket_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows', 'POST', path_params, @@ -256,7 +256,7 @@ def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs) select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions', 'POST', path_params, @@ -289,6 +289,8 @@ def delete_flow(self, bucket_id, flow_id, **kwargs): for asynchronous request. (optional) :param str bucket_id: The bucket identifier (required) :param str flow_id: The flow identifier (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: VersionedFlow If the method is called asynchronously, returns the request thread. @@ -316,12 +318,14 @@ def delete_flow_with_http_info(self, bucket_id, flow_id, **kwargs): for asynchronous request. (optional) :param str bucket_id: The bucket identifier (required) :param str flow_id: The flow identifier (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: VersionedFlow If the method is called asynchronously, returns the request thread. """ - all_params = ['bucket_id', 'flow_id'] + all_params = ['bucket_id', 'flow_id', 'version', 'client_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -353,6 +357,10 @@ def delete_flow_with_http_info(self, bucket_id, flow_id, **kwargs): path_params['flowId'] = params['flow_id'] query_params = [] + if 'version' in params: + query_params.append(('version', params['version'])) + if 'client_id' in params: + query_params.append(('clientId', params['client_id'])) header_params = {} @@ -369,7 +377,7 @@ def delete_flow_with_http_info(self, bucket_id, flow_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}', 'DELETE', path_params, @@ -482,7 +490,7 @@ def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}', 'GET', path_params, @@ -613,7 +621,7 @@ def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}', 'GET', path_params, @@ -735,7 +743,7 @@ def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, ** select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}', 'GET', path_params, @@ -848,7 +856,7 @@ def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions', 'GET', path_params, @@ -954,7 +962,7 @@ def get_flows_with_http_info(self, bucket_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows', 'GET', path_params, @@ -1067,7 +1075,7 @@ def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/latest', 'GET', path_params, @@ -1180,7 +1188,7 @@ def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, ** select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata', 'GET', path_params, @@ -1300,7 +1308,7 @@ def update_flow_with_http_info(self, bucket_id, flow_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}/flows/{flowId}', 'PUT', path_params, diff --git a/nipyapi/registry/apis/buckets_api.py b/nipyapi/registry/apis/buckets_api.py index edf9325a..1c7fe2d1 100644 --- a/nipyapi/registry/apis/buckets_api.py +++ b/nipyapi/registry/apis/buckets_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -129,7 +129,7 @@ def create_bucket_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets', 'POST', path_params, @@ -161,6 +161,8 @@ def delete_bucket(self, bucket_id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str bucket_id: The bucket identifier (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: Bucket If the method is called asynchronously, returns the request thread. @@ -187,12 +189,14 @@ def delete_bucket_with_http_info(self, bucket_id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str bucket_id: The bucket identifier (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: Bucket If the method is called asynchronously, returns the request thread. """ - all_params = ['bucket_id'] + all_params = ['bucket_id', 'version', 'client_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -219,6 +223,10 @@ def delete_bucket_with_http_info(self, bucket_id, **kwargs): path_params['bucketId'] = params['bucket_id'] query_params = [] + if 'version' in params: + query_params.append(('version', params['version'])) + if 'client_id' in params: + query_params.append(('clientId', params['client_id'])) header_params = {} @@ -235,7 +243,7 @@ def delete_bucket_with_http_info(self, bucket_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}', 'DELETE', path_params, @@ -333,7 +341,7 @@ def get_available_bucket_fields_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/fields', 'GET', path_params, @@ -439,7 +447,7 @@ def get_bucket_with_http_info(self, bucket_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}', 'GET', path_params, @@ -537,7 +545,7 @@ def get_buckets_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets', 'GET', path_params, @@ -650,7 +658,7 @@ def update_bucket_with_http_info(self, bucket_id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/buckets/{bucketId}', 'PUT', path_params, diff --git a/nipyapi/registry/apis/bundles_api.py b/nipyapi/registry/apis/bundles_api.py index 8c241619..1a141c35 100644 --- a/nipyapi/registry/apis/bundles_api.py +++ b/nipyapi/registry/apis/bundles_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -143,7 +143,7 @@ def get_bundle_version_extension_additional_details_docs_with_http_info(self, bu select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details', 'GET', path_params, @@ -263,7 +263,7 @@ def get_bundle_version_extension_docs_with_http_info(self, bundle_id, version, n select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}/docs', 'GET', path_params, @@ -374,7 +374,7 @@ def get_bundle_versions_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/versions', 'GET', path_params, @@ -485,7 +485,7 @@ def get_bundles_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles', 'GET', path_params, @@ -598,7 +598,7 @@ def global_delete_bundle_version_with_http_info(self, bundle_id, version, **kwar select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'DELETE', path_params, @@ -704,7 +704,7 @@ def global_delete_extension_bundle_with_http_info(self, bundle_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}', 'DELETE', path_params, @@ -817,7 +817,7 @@ def global_get_bundle_version_with_http_info(self, bundle_id, version, **kwargs) select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions/{version}', 'GET', path_params, @@ -930,7 +930,7 @@ def global_get_bundle_version_content_with_http_info(self, bundle_id, version, * select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/content', 'GET', path_params, @@ -1050,7 +1050,7 @@ def global_get_bundle_version_extension_with_http_info(self, bundle_id, version, select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions/{name}', 'GET', path_params, @@ -1163,7 +1163,7 @@ def global_get_bundle_version_extensions_with_http_info(self, bundle_id, version select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions/{version}/extensions', 'GET', path_params, @@ -1269,7 +1269,7 @@ def global_get_bundle_versions_with_http_info(self, bundle_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}/versions', 'GET', path_params, @@ -1375,7 +1375,7 @@ def global_get_extension_bundle_with_http_info(self, bundle_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/bundles/{bundleId}', 'GET', path_params, diff --git a/nipyapi/registry/apis/config_api.py b/nipyapi/registry/apis/config_api.py index 49c234b8..4a214dc6 100644 --- a/nipyapi/registry/apis/config_api.py +++ b/nipyapi/registry/apis/config_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -121,7 +121,7 @@ def get_configuration_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/config', 'GET', path_params, diff --git a/nipyapi/registry/apis/extension_repository_api.py b/nipyapi/registry/apis/extension_repository_api.py index 980b71c3..0846968f 100644 --- a/nipyapi/registry/apis/extension_repository_api.py +++ b/nipyapi/registry/apis/extension_repository_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -136,7 +136,7 @@ def get_extension_repo_artifacts_with_http_info(self, bucket_name, group_id, **k select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}', 'GET', path_params, @@ -234,7 +234,7 @@ def get_extension_repo_buckets_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository', 'GET', path_params, @@ -340,7 +340,7 @@ def get_extension_repo_groups_with_http_info(self, bucket_name, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}', 'GET', path_params, @@ -467,7 +467,7 @@ def get_extension_repo_version_with_http_info(self, bucket_name, group_id, artif select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}', 'GET', path_params, @@ -594,7 +594,7 @@ def get_extension_repo_version_content_with_http_info(self, bucket_name, group_i select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content', 'GET', path_params, @@ -728,7 +728,7 @@ def get_extension_repo_version_extension_with_http_info(self, bucket_name, group select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}', 'GET', path_params, @@ -862,7 +862,7 @@ def get_extension_repo_version_extension_additional_details_docs_with_http_info( select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details', 'GET', path_params, @@ -996,7 +996,7 @@ def get_extension_repo_version_extension_docs_with_http_info(self, bucket_name, select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs', 'GET', path_params, @@ -1123,7 +1123,7 @@ def get_extension_repo_version_extensions_with_http_info(self, bucket_name, grou select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions', 'GET', path_params, @@ -1250,7 +1250,7 @@ def get_extension_repo_version_sha256_with_http_info(self, bucket_name, group_id select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256', 'GET', path_params, @@ -1370,7 +1370,7 @@ def get_extension_repo_versions_with_http_info(self, bucket_name, group_id, arti select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{bucketName}/{groupId}/{artifactId}', 'GET', path_params, @@ -1490,7 +1490,7 @@ def get_global_extension_repo_version_sha256_with_http_info(self, group_id, arti select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extension-repository/{groupId}/{artifactId}/{version}/sha256', 'GET', path_params, diff --git a/nipyapi/registry/apis/extensions_api.py b/nipyapi/registry/apis/extensions_api.py index dd7446fb..e3c3ae39 100644 --- a/nipyapi/registry/apis/extensions_api.py +++ b/nipyapi/registry/apis/extensions_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -135,7 +135,7 @@ def get_extensions_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extensions', 'GET', path_params, @@ -262,7 +262,7 @@ def get_extensions_providing_service_api_with_http_info(self, class_name, group_ select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extensions/provided-service-api', 'GET', path_params, @@ -360,7 +360,7 @@ def get_tags_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/extensions/tags', 'GET', path_params, diff --git a/nipyapi/registry/apis/flows_api.py b/nipyapi/registry/apis/flows_api.py index d35abe90..1d6a97bb 100644 --- a/nipyapi/registry/apis/flows_api.py +++ b/nipyapi/registry/apis/flows_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -121,7 +121,7 @@ def get_available_flow_fields_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/flows/fields', 'GET', path_params, @@ -227,7 +227,7 @@ def global_get_flow_with_http_info(self, flow_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/flows/{flowId}', 'GET', path_params, @@ -342,7 +342,7 @@ def global_get_flow_version_with_http_info(self, flow_id, version_number, **kwar select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/flows/{flowId}/versions/{versionNumber}', 'GET', path_params, @@ -448,7 +448,7 @@ def global_get_flow_versions_with_http_info(self, flow_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/flows/{flowId}/versions', 'GET', path_params, @@ -554,7 +554,7 @@ def global_get_latest_flow_version_with_http_info(self, flow_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/flows/{flowId}/versions/latest', 'GET', path_params, @@ -660,7 +660,7 @@ def global_get_latest_flow_version_metadata_with_http_info(self, flow_id, **kwar select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/flows/{flowId}/versions/latest/metadata', 'GET', path_params, diff --git a/nipyapi/registry/apis/items_api.py b/nipyapi/registry/apis/items_api.py index 6ce7e063..1138bc0d 100644 --- a/nipyapi/registry/apis/items_api.py +++ b/nipyapi/registry/apis/items_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -121,7 +121,7 @@ def get_available_bucket_item_fields_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/items/fields', 'GET', path_params, @@ -219,7 +219,7 @@ def get_items_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/items', 'GET', path_params, @@ -325,7 +325,7 @@ def get_items_in_bucket_with_http_info(self, bucket_id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/items/{bucketId}', 'GET', path_params, diff --git a/nipyapi/registry/apis/policies_api.py b/nipyapi/registry/apis/policies_api.py index 57af7df8..5f911d9c 100644 --- a/nipyapi/registry/apis/policies_api.py +++ b/nipyapi/registry/apis/policies_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -129,7 +129,7 @@ def create_access_policy_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/policies', 'POST', path_params, @@ -227,7 +227,7 @@ def get_access_policies_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/policies', 'GET', path_params, @@ -333,7 +333,7 @@ def get_access_policy_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/policies/{id}', 'GET', path_params, @@ -448,7 +448,7 @@ def get_access_policy_for_resource_with_http_info(self, action, resource, **kwar select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/policies/{action}/{resource}', 'GET', path_params, @@ -546,7 +546,7 @@ def get_resources_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/policies/resources', 'GET', path_params, @@ -578,6 +578,8 @@ def remove_access_policy(self, id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str id: The access policy id. (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: AccessPolicy If the method is called asynchronously, returns the request thread. @@ -604,12 +606,14 @@ def remove_access_policy_with_http_info(self, id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str id: The access policy id. (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: AccessPolicy If the method is called asynchronously, returns the request thread. """ - all_params = ['id'] + all_params = ['id', 'version', 'client_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -636,6 +640,10 @@ def remove_access_policy_with_http_info(self, id, **kwargs): path_params['id'] = params['id'] query_params = [] + if 'version' in params: + query_params.append(('version', params['version'])) + if 'client_id' in params: + query_params.append(('clientId', params['client_id'])) header_params = {} @@ -652,7 +660,7 @@ def remove_access_policy_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/policies/{id}', 'DELETE', path_params, @@ -765,7 +773,7 @@ def update_access_policy_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/policies/{id}', 'PUT', path_params, diff --git a/nipyapi/registry/apis/tenants_api.py b/nipyapi/registry/apis/tenants_api.py index dcab2d29..6ea6e8e5 100644 --- a/nipyapi/registry/apis/tenants_api.py +++ b/nipyapi/registry/apis/tenants_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -129,7 +129,7 @@ def create_user_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/users', 'POST', path_params, @@ -235,7 +235,7 @@ def create_user_group_with_http_info(self, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/user-groups', 'POST', path_params, @@ -341,7 +341,7 @@ def get_user_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/users/{id}', 'GET', path_params, @@ -447,7 +447,7 @@ def get_user_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/user-groups/{id}', 'GET', path_params, @@ -545,7 +545,7 @@ def get_user_groups_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/user-groups', 'GET', path_params, @@ -643,7 +643,7 @@ def get_users_with_http_info(self, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/users', 'GET', path_params, @@ -675,6 +675,8 @@ def remove_user(self, id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str id: The user id. (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: User If the method is called asynchronously, returns the request thread. @@ -701,12 +703,14 @@ def remove_user_with_http_info(self, id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str id: The user id. (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: User If the method is called asynchronously, returns the request thread. """ - all_params = ['id'] + all_params = ['id', 'version', 'client_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -733,6 +737,10 @@ def remove_user_with_http_info(self, id, **kwargs): path_params['id'] = params['id'] query_params = [] + if 'version' in params: + query_params.append(('version', params['version'])) + if 'client_id' in params: + query_params.append(('clientId', params['client_id'])) header_params = {} @@ -749,7 +757,7 @@ def remove_user_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/users/{id}', 'DELETE', path_params, @@ -781,6 +789,8 @@ def remove_user_group(self, id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str id: The user group id. (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: UserGroup If the method is called asynchronously, returns the request thread. @@ -807,12 +817,14 @@ def remove_user_group_with_http_info(self, id, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param str id: The user group id. (required) + :param str version: The version is used to verify the client is working with the latest version of the entity. + :param str client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. :return: UserGroup If the method is called asynchronously, returns the request thread. """ - all_params = ['id'] + all_params = ['id', 'version', 'client_id'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -839,6 +851,10 @@ def remove_user_group_with_http_info(self, id, **kwargs): path_params['id'] = params['id'] query_params = [] + if 'version' in params: + query_params.append(('version', params['version'])) + if 'client_id' in params: + query_params.append(('clientId', params['client_id'])) header_params = {} @@ -855,7 +871,7 @@ def remove_user_group_with_http_info(self, id, **kwargs): select_header_content_type(['*/*']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/user-groups/{id}', 'DELETE', path_params, @@ -968,7 +984,7 @@ def update_user_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/users/{id}', 'PUT', path_params, @@ -1081,7 +1097,7 @@ def update_user_group_with_http_info(self, id, body, **kwargs): select_header_content_type(['application/json']) # Authentication setting - auth_settings = ['tokenAuth', 'Authorization'] + auth_settings = ['tokenAuth', 'basicAuth', 'Authorization'] return self.api_client.call_api('/tenants/user-groups/{id}', 'PUT', path_params, diff --git a/nipyapi/registry/configuration.py b/nipyapi/registry/configuration.py index 543f5921..e9632b6b 100644 --- a/nipyapi/registry/configuration.py +++ b/nipyapi/registry/configuration.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -52,6 +52,8 @@ def __init__(self): self.temp_folder_path = None # Authentication Settings + # Auth types to enable + self.enabled_auth = ['tokenAuth', 'basicAuth'] # dict to store API key(s) self.api_key = {} # dict to store API prefix (e.g. Bearer) @@ -188,10 +190,12 @@ def get_api_key_with_prefix(self, identifier): :param identifier: The identifier of apiKey. :return: The token for api key authentication. """ - if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): - return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] - elif self.api_key.get(identifier): - return self.api_key[identifier] + if identifier in self.enabled_auth: + if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): + return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] + elif self.api_key.get(identifier): + return self.api_key[identifier] + return None def get_basic_auth_token(self): """ @@ -199,8 +203,10 @@ def get_basic_auth_token(self): :return: The token for basic HTTP authentication. """ - return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ - .get('authorization') + if 'basicAuth' in self.enabled_auth: + return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ + .get('authorization') + return None def auth_settings(self): """ @@ -216,6 +222,13 @@ def auth_settings(self): 'key': 'Authorization', 'value': self.get_api_key_with_prefix('tokenAuth') }, + 'basicAuth': + { + 'type': 'basic', + 'in': 'header', + 'key': 'Authorization', + 'value': self.get_basic_auth_token() + }, 'Authorization': { 'type': 'api_key', @@ -242,6 +255,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 0.5.0\n"\ + "Version of the API: 0.7.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/registry/models/__init__.py b/nipyapi/registry/models/__init__.py index 3352313d..dcd26acd 100644 --- a/nipyapi/registry/models/__init__.py +++ b/nipyapi/registry/models/__init__.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -59,6 +59,7 @@ from .resource_permissions import ResourcePermissions from .restricted import Restricted from .restriction import Restriction +from .revision_info import RevisionInfo from .stateful import Stateful from .system_resource_consideration import SystemResourceConsideration from .tag_count import TagCount diff --git a/nipyapi/registry/models/access_policy.py b/nipyapi/registry/models/access_policy.py index 7cf47e3d..c28fcf6e 100644 --- a/nipyapi/registry/models/access_policy.py +++ b/nipyapi/registry/models/access_policy.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -35,6 +35,7 @@ class AccessPolicy(object): 'resource': 'str', 'action': 'str', 'configurable': 'bool', + 'revision': 'RevisionInfo', 'users': 'list[Tenant]', 'user_groups': 'list[Tenant]' } @@ -44,11 +45,12 @@ class AccessPolicy(object): 'resource': 'resource', 'action': 'action', 'configurable': 'configurable', + 'revision': 'revision', 'users': 'users', 'user_groups': 'userGroups' } - def __init__(self, identifier=None, resource=None, action=None, configurable=None, users=None, user_groups=None): + def __init__(self, identifier=None, resource=None, action=None, configurable=None, revision=None, users=None, user_groups=None): """ AccessPolicy - a model defined in Swagger """ @@ -57,6 +59,7 @@ def __init__(self, identifier=None, resource=None, action=None, configurable=Non self._resource = None self._action = None self._configurable = None + self._revision = None self._users = None self._user_groups = None @@ -66,6 +69,8 @@ def __init__(self, identifier=None, resource=None, action=None, configurable=Non self.action = action if configurable is not None: self.configurable = configurable + if revision is not None: + self.revision = revision if users is not None: self.users = users if user_groups is not None: @@ -173,6 +178,29 @@ def configurable(self, configurable): self._configurable = configurable + @property + def revision(self): + """ + Gets the revision of this AccessPolicy. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this AccessPolicy. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this AccessPolicy. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this AccessPolicy. + :type: RevisionInfo + """ + + self._revision = revision + @property def users(self): """ diff --git a/nipyapi/registry/models/access_policy_summary.py b/nipyapi/registry/models/access_policy_summary.py index 8e3cf9dc..3104aeb4 100644 --- a/nipyapi/registry/models/access_policy_summary.py +++ b/nipyapi/registry/models/access_policy_summary.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -34,17 +34,19 @@ class AccessPolicySummary(object): 'identifier': 'str', 'resource': 'str', 'action': 'str', - 'configurable': 'bool' + 'configurable': 'bool', + 'revision': 'RevisionInfo' } attribute_map = { 'identifier': 'identifier', 'resource': 'resource', 'action': 'action', - 'configurable': 'configurable' + 'configurable': 'configurable', + 'revision': 'revision' } - def __init__(self, identifier=None, resource=None, action=None, configurable=None): + def __init__(self, identifier=None, resource=None, action=None, configurable=None, revision=None): """ AccessPolicySummary - a model defined in Swagger """ @@ -53,6 +55,7 @@ def __init__(self, identifier=None, resource=None, action=None, configurable=Non self._resource = None self._action = None self._configurable = None + self._revision = None if identifier is not None: self.identifier = identifier @@ -60,6 +63,8 @@ def __init__(self, identifier=None, resource=None, action=None, configurable=Non self.action = action if configurable is not None: self.configurable = configurable + if revision is not None: + self.revision = revision @property def identifier(self): @@ -163,6 +168,29 @@ def configurable(self, configurable): self._configurable = configurable + @property + def revision(self): + """ + Gets the revision of this AccessPolicySummary. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this AccessPolicySummary. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this AccessPolicySummary. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this AccessPolicySummary. + :type: RevisionInfo + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/allowable_value.py b/nipyapi/registry/models/allowable_value.py index ee2d8e00..9f7508df 100644 --- a/nipyapi/registry/models/allowable_value.py +++ b/nipyapi/registry/models/allowable_value.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/attribute.py b/nipyapi/registry/models/attribute.py index 978ea6ac..0cd09ad0 100644 --- a/nipyapi/registry/models/attribute.py +++ b/nipyapi/registry/models/attribute.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/batch_size.py b/nipyapi/registry/models/batch_size.py index 054db44a..ead43ce8 100644 --- a/nipyapi/registry/models/batch_size.py +++ b/nipyapi/registry/models/batch_size.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bucket.py b/nipyapi/registry/models/bucket.py index 65faf655..39a9e57f 100644 --- a/nipyapi/registry/models/bucket.py +++ b/nipyapi/registry/models/bucket.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,8 @@ class Bucket(object): 'description': 'str', 'allow_bundle_redeploy': 'bool', 'allow_public_read': 'bool', - 'permissions': 'Permissions' + 'permissions': 'Permissions', + 'revision': 'RevisionInfo' } attribute_map = { @@ -49,10 +50,11 @@ class Bucket(object): 'description': 'description', 'allow_bundle_redeploy': 'allowBundleRedeploy', 'allow_public_read': 'allowPublicRead', - 'permissions': 'permissions' + 'permissions': 'permissions', + 'revision': 'revision' } - def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None): + def __init__(self, link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None, revision=None): """ Bucket - a model defined in Swagger """ @@ -65,6 +67,7 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self._allow_bundle_redeploy = None self._allow_public_read = None self._permissions = None + self._revision = None if link is not None: self.link = link @@ -81,6 +84,8 @@ def __init__(self, link=None, identifier=None, name=None, created_timestamp=None self.allow_public_read = allow_public_read if permissions is not None: self.permissions = permissions + if revision is not None: + self.revision = revision @property def link(self): @@ -270,6 +275,29 @@ def permissions(self, permissions): self._permissions = permissions + @property + def revision(self): + """ + Gets the revision of this Bucket. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this Bucket. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this Bucket. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this Bucket. + :type: RevisionInfo + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/bucket_item.py b/nipyapi/registry/models/bucket_item.py index 3444b54e..282b8719 100644 --- a/nipyapi/registry/models/bucket_item.py +++ b/nipyapi/registry/models/bucket_item.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/build_info.py b/nipyapi/registry/models/build_info.py index 09ff6c2c..a0c5e277 100644 --- a/nipyapi/registry/models/build_info.py +++ b/nipyapi/registry/models/build_info.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle.py b/nipyapi/registry/models/bundle.py index f3831997..5df9fc3b 100644 --- a/nipyapi/registry/models/bundle.py +++ b/nipyapi/registry/models/bundle.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_info.py b/nipyapi/registry/models/bundle_info.py index 599cd8c7..c0b1e0ff 100644 --- a/nipyapi/registry/models/bundle_info.py +++ b/nipyapi/registry/models/bundle_info.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_version.py b/nipyapi/registry/models/bundle_version.py index ca80773e..3ea9ee0e 100644 --- a/nipyapi/registry/models/bundle_version.py +++ b/nipyapi/registry/models/bundle_version.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_version_dependency.py b/nipyapi/registry/models/bundle_version_dependency.py index 9e4b1ad9..6f4a9e2a 100644 --- a/nipyapi/registry/models/bundle_version_dependency.py +++ b/nipyapi/registry/models/bundle_version_dependency.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_version_metadata.py b/nipyapi/registry/models/bundle_version_metadata.py index de7963a9..5b325046 100644 --- a/nipyapi/registry/models/bundle_version_metadata.py +++ b/nipyapi/registry/models/bundle_version_metadata.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/component_difference.py b/nipyapi/registry/models/component_difference.py index 61d4c563..2b579bb2 100644 --- a/nipyapi/registry/models/component_difference.py +++ b/nipyapi/registry/models/component_difference.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/component_difference_group.py b/nipyapi/registry/models/component_difference_group.py index 3c939d7f..aa590b3c 100644 --- a/nipyapi/registry/models/component_difference_group.py +++ b/nipyapi/registry/models/component_difference_group.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/connectable_component.py b/nipyapi/registry/models/connectable_component.py index 2ca0c5f7..17797f5c 100644 --- a/nipyapi/registry/models/connectable_component.py +++ b/nipyapi/registry/models/connectable_component.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/controller_service_api.py b/nipyapi/registry/models/controller_service_api.py index 324422b9..536c09da 100644 --- a/nipyapi/registry/models/controller_service_api.py +++ b/nipyapi/registry/models/controller_service_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/controller_service_definition.py b/nipyapi/registry/models/controller_service_definition.py index 4e359280..78bec67a 100644 --- a/nipyapi/registry/models/controller_service_definition.py +++ b/nipyapi/registry/models/controller_service_definition.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/current_user.py b/nipyapi/registry/models/current_user.py index af718f3a..811f0c6f 100644 --- a/nipyapi/registry/models/current_user.py +++ b/nipyapi/registry/models/current_user.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/deprecation_notice.py b/nipyapi/registry/models/deprecation_notice.py index 454c3151..5123478c 100644 --- a/nipyapi/registry/models/deprecation_notice.py +++ b/nipyapi/registry/models/deprecation_notice.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/dynamic_property.py b/nipyapi/registry/models/dynamic_property.py index b261ea10..f0102203 100644 --- a/nipyapi/registry/models/dynamic_property.py +++ b/nipyapi/registry/models/dynamic_property.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/dynamic_relationship.py b/nipyapi/registry/models/dynamic_relationship.py index 3700ddb0..f2e482fc 100644 --- a/nipyapi/registry/models/dynamic_relationship.py +++ b/nipyapi/registry/models/dynamic_relationship.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension.py b/nipyapi/registry/models/extension.py index fb2ee08a..06ef88b8 100644 --- a/nipyapi/registry/models/extension.py +++ b/nipyapi/registry/models/extension.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_bundle.py b/nipyapi/registry/models/extension_bundle.py index 296af2b5..d1c64742 100644 --- a/nipyapi/registry/models/extension_bundle.py +++ b/nipyapi/registry/models/extension_bundle.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_filter_params.py b/nipyapi/registry/models/extension_filter_params.py index ad32f038..a9d29841 100644 --- a/nipyapi/registry/models/extension_filter_params.py +++ b/nipyapi/registry/models/extension_filter_params.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_metadata.py b/nipyapi/registry/models/extension_metadata.py index e15a2cfa..d2214e2a 100644 --- a/nipyapi/registry/models/extension_metadata.py +++ b/nipyapi/registry/models/extension_metadata.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_metadata_container.py b/nipyapi/registry/models/extension_metadata_container.py index ae7448be..d243f2d7 100644 --- a/nipyapi/registry/models/extension_metadata_container.py +++ b/nipyapi/registry/models/extension_metadata_container.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_artifact.py b/nipyapi/registry/models/extension_repo_artifact.py index be75af9f..5d2644ac 100644 --- a/nipyapi/registry/models/extension_repo_artifact.py +++ b/nipyapi/registry/models/extension_repo_artifact.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_bucket.py b/nipyapi/registry/models/extension_repo_bucket.py index 265596a3..e2f6ad88 100644 --- a/nipyapi/registry/models/extension_repo_bucket.py +++ b/nipyapi/registry/models/extension_repo_bucket.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_group.py b/nipyapi/registry/models/extension_repo_group.py index 97f05db6..43b01745 100644 --- a/nipyapi/registry/models/extension_repo_group.py +++ b/nipyapi/registry/models/extension_repo_group.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_version.py b/nipyapi/registry/models/extension_repo_version.py index 6307a86d..74115cee 100644 --- a/nipyapi/registry/models/extension_repo_version.py +++ b/nipyapi/registry/models/extension_repo_version.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_version_summary.py b/nipyapi/registry/models/extension_repo_version_summary.py index 19ca56af..28cea9d4 100644 --- a/nipyapi/registry/models/extension_repo_version_summary.py +++ b/nipyapi/registry/models/extension_repo_version_summary.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/external_controller_service_reference.py b/nipyapi/registry/models/external_controller_service_reference.py index 0a15fe35..64f82bbd 100644 --- a/nipyapi/registry/models/external_controller_service_reference.py +++ b/nipyapi/registry/models/external_controller_service_reference.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/fields.py b/nipyapi/registry/models/fields.py index 0368a86d..7f7e08aa 100644 --- a/nipyapi/registry/models/fields.py +++ b/nipyapi/registry/models/fields.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/jaxb_link.py b/nipyapi/registry/models/jaxb_link.py index 6e42823e..17133682 100644 --- a/nipyapi/registry/models/jaxb_link.py +++ b/nipyapi/registry/models/jaxb_link.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/model_property.py b/nipyapi/registry/models/model_property.py index b803f124..642e4884 100644 --- a/nipyapi/registry/models/model_property.py +++ b/nipyapi/registry/models/model_property.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/permissions.py b/nipyapi/registry/models/permissions.py index 5fcc366d..3ad49eb4 100644 --- a/nipyapi/registry/models/permissions.py +++ b/nipyapi/registry/models/permissions.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/position.py b/nipyapi/registry/models/position.py index 64d4f71d..f8671e74 100644 --- a/nipyapi/registry/models/position.py +++ b/nipyapi/registry/models/position.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/provided_service_api.py b/nipyapi/registry/models/provided_service_api.py index 4809d6fe..e0f92ce2 100644 --- a/nipyapi/registry/models/provided_service_api.py +++ b/nipyapi/registry/models/provided_service_api.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/registry_configuration.py b/nipyapi/registry/models/registry_configuration.py index ec57a0e9..c667f049 100644 --- a/nipyapi/registry/models/registry_configuration.py +++ b/nipyapi/registry/models/registry_configuration.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/relationship.py b/nipyapi/registry/models/relationship.py index f8063d28..50b80be0 100644 --- a/nipyapi/registry/models/relationship.py +++ b/nipyapi/registry/models/relationship.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/resource.py b/nipyapi/registry/models/resource.py index 06f6e717..f5cf9ebe 100644 --- a/nipyapi/registry/models/resource.py +++ b/nipyapi/registry/models/resource.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/resource_permissions.py b/nipyapi/registry/models/resource_permissions.py index 95119242..d2837820 100644 --- a/nipyapi/registry/models/resource_permissions.py +++ b/nipyapi/registry/models/resource_permissions.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/restricted.py b/nipyapi/registry/models/restricted.py index f3418b9e..f52fecd3 100644 --- a/nipyapi/registry/models/restricted.py +++ b/nipyapi/registry/models/restricted.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/restriction.py b/nipyapi/registry/models/restriction.py index fbf3b691..708b7546 100644 --- a/nipyapi/registry/models/restriction.py +++ b/nipyapi/registry/models/restriction.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/revision_info.py b/nipyapi/registry/models/revision_info.py new file mode 100644 index 00000000..2cae9566 --- /dev/null +++ b/nipyapi/registry/models/revision_info.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + 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: 0.7.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class RevisionInfo(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'client_id': 'str', + 'version': 'int', + 'last_modifier': 'str' + } + + attribute_map = { + 'client_id': 'clientId', + 'version': 'version', + 'last_modifier': 'lastModifier' + } + + def __init__(self, client_id=None, version=None, last_modifier=None): + """ + RevisionInfo - a model defined in Swagger + """ + + self._client_id = None + self._version = None + self._last_modifier = None + + if client_id is not None: + self.client_id = client_id + if version is not None: + self.version = version + if last_modifier is not None: + self.last_modifier = last_modifier + + @property + def client_id(self): + """ + Gets the client_id of this RevisionInfo. + 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. + + :return: The client_id of this RevisionInfo. + :rtype: str + """ + return self._client_id + + @client_id.setter + def client_id(self, client_id): + """ + Sets the client_id of this RevisionInfo. + 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. + + :param client_id: The client_id of this RevisionInfo. + :type: str + """ + + self._client_id = client_id + + @property + def version(self): + """ + Gets the version of this RevisionInfo. + NiFi Registry 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. + + :return: The version of this RevisionInfo. + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """ + Sets the version of this RevisionInfo. + NiFi Registry 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. + + :param version: The version of this RevisionInfo. + :type: int + """ + + self._version = version + + @property + def last_modifier(self): + """ + Gets the last_modifier of this RevisionInfo. + The user that last modified the entity. + + :return: The last_modifier of this RevisionInfo. + :rtype: str + """ + return self._last_modifier + + @last_modifier.setter + def last_modifier(self, last_modifier): + """ + Sets the last_modifier of this RevisionInfo. + The user that last modified the entity. + + :param last_modifier: The last_modifier of this RevisionInfo. + :type: str + """ + + self._last_modifier = last_modifier + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, RevisionInfo): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/registry/models/stateful.py b/nipyapi/registry/models/stateful.py index bd0fa557..a5d987fd 100644 --- a/nipyapi/registry/models/stateful.py +++ b/nipyapi/registry/models/stateful.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/system_resource_consideration.py b/nipyapi/registry/models/system_resource_consideration.py index 84acb247..5349b40c 100644 --- a/nipyapi/registry/models/system_resource_consideration.py +++ b/nipyapi/registry/models/system_resource_consideration.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/tag_count.py b/nipyapi/registry/models/tag_count.py index cf34e0ee..12d41715 100644 --- a/nipyapi/registry/models/tag_count.py +++ b/nipyapi/registry/models/tag_count.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/tenant.py b/nipyapi/registry/models/tenant.py index b087e523..2fb51a7b 100644 --- a/nipyapi/registry/models/tenant.py +++ b/nipyapi/registry/models/tenant.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -35,7 +35,8 @@ class Tenant(object): 'identity': 'str', 'configurable': 'bool', 'resource_permissions': 'ResourcePermissions', - 'access_policies': 'list[AccessPolicySummary]' + 'access_policies': 'list[AccessPolicySummary]', + 'revision': 'RevisionInfo' } attribute_map = { @@ -43,10 +44,11 @@ class Tenant(object): 'identity': 'identity', 'configurable': 'configurable', 'resource_permissions': 'resourcePermissions', - 'access_policies': 'accessPolicies' + 'access_policies': 'accessPolicies', + 'revision': 'revision' } - def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None): + def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None): """ Tenant - a model defined in Swagger """ @@ -56,6 +58,7 @@ def __init__(self, identifier=None, identity=None, configurable=None, resource_p self._configurable = None self._resource_permissions = None self._access_policies = None + self._revision = None if identifier is not None: self.identifier = identifier @@ -66,6 +69,8 @@ def __init__(self, identifier=None, identity=None, configurable=None, resource_p self.resource_permissions = resource_permissions if access_policies is not None: self.access_policies = access_policies + if revision is not None: + self.revision = revision @property def identifier(self): @@ -184,6 +189,29 @@ def access_policies(self, access_policies): self._access_policies = access_policies + @property + def revision(self): + """ + Gets the revision of this Tenant. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this Tenant. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this Tenant. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this Tenant. + :type: RevisionInfo + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/user.py b/nipyapi/registry/models/user.py index 06b3f2f3..77f6aef8 100644 --- a/nipyapi/registry/models/user.py +++ b/nipyapi/registry/models/user.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -36,6 +36,7 @@ class User(object): 'configurable': 'bool', 'resource_permissions': 'ResourcePermissions', 'access_policies': 'list[AccessPolicySummary]', + 'revision': 'RevisionInfo', 'user_groups': 'list[Tenant]' } @@ -45,10 +46,11 @@ class User(object): 'configurable': 'configurable', 'resource_permissions': 'resourcePermissions', 'access_policies': 'accessPolicies', + 'revision': 'revision', 'user_groups': 'userGroups' } - def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, user_groups=None): + def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, user_groups=None): """ User - a model defined in Swagger """ @@ -58,6 +60,7 @@ def __init__(self, identifier=None, identity=None, configurable=None, resource_p self._configurable = None self._resource_permissions = None self._access_policies = None + self._revision = None self._user_groups = None if identifier is not None: @@ -69,6 +72,8 @@ def __init__(self, identifier=None, identity=None, configurable=None, resource_p self.resource_permissions = resource_permissions if access_policies is not None: self.access_policies = access_policies + if revision is not None: + self.revision = revision if user_groups is not None: self.user_groups = user_groups @@ -189,6 +194,29 @@ def access_policies(self, access_policies): self._access_policies = access_policies + @property + def revision(self): + """ + Gets the revision of this User. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this User. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this User. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this User. + :type: RevisionInfo + """ + + self._revision = revision + @property def user_groups(self): """ diff --git a/nipyapi/registry/models/user_group.py b/nipyapi/registry/models/user_group.py index 0819dc6d..d48b7dee 100644 --- a/nipyapi/registry/models/user_group.py +++ b/nipyapi/registry/models/user_group.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -36,6 +36,7 @@ class UserGroup(object): 'configurable': 'bool', 'resource_permissions': 'ResourcePermissions', 'access_policies': 'list[AccessPolicySummary]', + 'revision': 'RevisionInfo', 'users': 'list[Tenant]' } @@ -45,10 +46,11 @@ class UserGroup(object): 'configurable': 'configurable', 'resource_permissions': 'resourcePermissions', 'access_policies': 'accessPolicies', + 'revision': 'revision', 'users': 'users' } - def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, users=None): + def __init__(self, identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, users=None): """ UserGroup - a model defined in Swagger """ @@ -58,6 +60,7 @@ def __init__(self, identifier=None, identity=None, configurable=None, resource_p self._configurable = None self._resource_permissions = None self._access_policies = None + self._revision = None self._users = None if identifier is not None: @@ -69,6 +72,8 @@ def __init__(self, identifier=None, identity=None, configurable=None, resource_p self.resource_permissions = resource_permissions if access_policies is not None: self.access_policies = access_policies + if revision is not None: + self.revision = revision if users is not None: self.users = users @@ -189,6 +194,29 @@ def access_policies(self, access_policies): self._access_policies = access_policies + @property + def revision(self): + """ + Gets the revision of this UserGroup. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this UserGroup. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this UserGroup. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this UserGroup. + :type: RevisionInfo + """ + + self._revision = revision + @property def users(self): """ diff --git a/nipyapi/registry/models/versioned_connection.py b/nipyapi/registry/models/versioned_connection.py index 25bccaa1..6b3f783d 100644 --- a/nipyapi/registry/models/versioned_connection.py +++ b/nipyapi/registry/models/versioned_connection.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_controller_service.py b/nipyapi/registry/models/versioned_controller_service.py index 0bd67613..c820cece 100644 --- a/nipyapi/registry/models/versioned_controller_service.py +++ b/nipyapi/registry/models/versioned_controller_service.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow.py b/nipyapi/registry/models/versioned_flow.py index 6ba36e31..093f7ff7 100644 --- a/nipyapi/registry/models/versioned_flow.py +++ b/nipyapi/registry/models/versioned_flow.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -41,7 +41,8 @@ class VersionedFlow(object): 'modified_timestamp': 'int', 'type': 'str', 'permissions': 'Permissions', - 'version_count': 'int' + 'version_count': 'int', + 'revision': 'RevisionInfo' } attribute_map = { @@ -55,10 +56,11 @@ class VersionedFlow(object): 'modified_timestamp': 'modifiedTimestamp', 'type': 'type', 'permissions': 'permissions', - 'version_count': 'versionCount' + 'version_count': 'versionCount', + 'revision': 'revision' } - def __init__(self, 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): + def __init__(self, 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): """ VersionedFlow - a model defined in Swagger """ @@ -74,6 +76,7 @@ def __init__(self, link=None, identifier=None, name=None, description=None, buck self._type = None self._permissions = None self._version_count = None + self._revision = None if link is not None: self.link = link @@ -94,6 +97,8 @@ def __init__(self, link=None, identifier=None, name=None, description=None, buck self.permissions = permissions if version_count is not None: self.version_count = version_count + if revision is not None: + self.revision = revision @property def link(self): @@ -366,6 +371,29 @@ def version_count(self, version_count): self._version_count = version_count + @property + def revision(self): + """ + Gets the revision of this VersionedFlow. + The revision of this entity used for optimistic-locking during updates. + + :return: The revision of this VersionedFlow. + :rtype: RevisionInfo + """ + return self._revision + + @revision.setter + def revision(self, revision): + """ + Sets the revision of this VersionedFlow. + The revision of this entity used for optimistic-locking during updates. + + :param revision: The revision of this VersionedFlow. + :type: RevisionInfo + """ + + self._revision = revision + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/registry/models/versioned_flow_coordinates.py b/nipyapi/registry/models/versioned_flow_coordinates.py index 5d3ffd05..2631dc93 100644 --- a/nipyapi/registry/models/versioned_flow_coordinates.py +++ b/nipyapi/registry/models/versioned_flow_coordinates.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_difference.py b/nipyapi/registry/models/versioned_flow_difference.py index 5fdf9f76..62b18ca2 100644 --- a/nipyapi/registry/models/versioned_flow_difference.py +++ b/nipyapi/registry/models/versioned_flow_difference.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot.py b/nipyapi/registry/models/versioned_flow_snapshot.py index 384eb081..a51b4242 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot.py +++ b/nipyapi/registry/models/versioned_flow_snapshot.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py index 6ef9847c..d6ae44fa 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_funnel.py b/nipyapi/registry/models/versioned_funnel.py index a12b61a7..3e04a645 100644 --- a/nipyapi/registry/models/versioned_funnel.py +++ b/nipyapi/registry/models/versioned_funnel.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_label.py b/nipyapi/registry/models/versioned_label.py index 0a341dd8..f3255ee5 100644 --- a/nipyapi/registry/models/versioned_label.py +++ b/nipyapi/registry/models/versioned_label.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_parameter.py b/nipyapi/registry/models/versioned_parameter.py index 0efa6516..02ca5d32 100644 --- a/nipyapi/registry/models/versioned_parameter.py +++ b/nipyapi/registry/models/versioned_parameter.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_parameter_context.py b/nipyapi/registry/models/versioned_parameter_context.py index 4ae3dbd8..24e708a9 100644 --- a/nipyapi/registry/models/versioned_parameter_context.py +++ b/nipyapi/registry/models/versioned_parameter_context.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_port.py b/nipyapi/registry/models/versioned_port.py index 90f1465c..8ac57786 100644 --- a/nipyapi/registry/models/versioned_port.py +++ b/nipyapi/registry/models/versioned_port.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_process_group.py b/nipyapi/registry/models/versioned_process_group.py index 9ee76f41..49e324be 100644 --- a/nipyapi/registry/models/versioned_process_group.py +++ b/nipyapi/registry/models/versioned_process_group.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -48,6 +48,8 @@ class VersionedProcessGroup(object): 'variables': 'dict(str, str)', 'parameter_context_name': 'str', 'component_type': 'str', + 'flow_file_outbound_policy': 'str', + 'flow_file_concurrency': 'str', 'group_identifier': 'str' } @@ -69,10 +71,12 @@ class VersionedProcessGroup(object): 'variables': 'variables', 'parameter_context_name': 'parameterContextName', 'component_type': 'componentType', + 'flow_file_outbound_policy': 'flowFileOutboundPolicy', + 'flow_file_concurrency': 'flowFileConcurrency', 'group_identifier': 'groupIdentifier' } - def __init__(self, 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, component_type=None, group_identifier=None): + def __init__(self, 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, component_type=None, flow_file_outbound_policy=None, flow_file_concurrency=None, group_identifier=None): """ VersionedProcessGroup - a model defined in Swagger """ @@ -94,6 +98,8 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self._variables = None self._parameter_context_name = None self._component_type = None + self._flow_file_outbound_policy = None + self._flow_file_concurrency = None self._group_identifier = None if identifier is not None: @@ -130,6 +136,10 @@ def __init__(self, identifier=None, name=None, comments=None, position=None, pro self.parameter_context_name = parameter_context_name if component_type is not None: self.component_type = component_type + if flow_file_outbound_policy is not None: + self.flow_file_outbound_policy = flow_file_outbound_policy + if flow_file_concurrency is not None: + self.flow_file_concurrency = flow_file_concurrency if group_identifier is not None: self.group_identifier = group_identifier @@ -528,6 +538,52 @@ def component_type(self, component_type): self._component_type = component_type + @property + def flow_file_outbound_policy(self): + """ + Gets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group + + :return: The flow_file_outbound_policy of this VersionedProcessGroup. + :rtype: str + """ + return self._flow_file_outbound_policy + + @flow_file_outbound_policy.setter + def flow_file_outbound_policy(self, flow_file_outbound_policy): + """ + Sets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group + + :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. + :type: str + """ + + self._flow_file_outbound_policy = flow_file_outbound_policy + + @property + def flow_file_concurrency(self): + """ + Gets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group + + :return: The flow_file_concurrency of this VersionedProcessGroup. + :rtype: str + """ + return self._flow_file_concurrency + + @flow_file_concurrency.setter + def flow_file_concurrency(self, flow_file_concurrency): + """ + Sets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group + + :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. + :type: str + """ + + self._flow_file_concurrency = flow_file_concurrency + @property def group_identifier(self): """ diff --git a/nipyapi/registry/models/versioned_processor.py b/nipyapi/registry/models/versioned_processor.py index 0346939d..22a76dfd 100644 --- a/nipyapi/registry/models/versioned_processor.py +++ b/nipyapi/registry/models/versioned_processor.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_property_descriptor.py b/nipyapi/registry/models/versioned_property_descriptor.py index 90f9c72f..29e7c059 100644 --- a/nipyapi/registry/models/versioned_property_descriptor.py +++ b/nipyapi/registry/models/versioned_property_descriptor.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_remote_group_port.py b/nipyapi/registry/models/versioned_remote_group_port.py index 0eff66b6..7b2fc20b 100644 --- a/nipyapi/registry/models/versioned_remote_group_port.py +++ b/nipyapi/registry/models/versioned_remote_group_port.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_remote_process_group.py b/nipyapi/registry/models/versioned_remote_process_group.py index acbdba3d..1e13ae46 100644 --- a/nipyapi/registry/models/versioned_remote_process_group.py +++ b/nipyapi/registry/models/versioned_remote_process_group.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/rest.py b/nipyapi/registry/rest.py index 05edc1ac..f929bfbb 100644 --- a/nipyapi/registry/rest.py +++ b/nipyapi/registry/rest.py @@ -5,7 +5,7 @@ The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components. - OpenAPI spec version: 0.5.0 + OpenAPI spec version: 0.7.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/security.py b/nipyapi/security.py index 9ecdc8ad..96fa20e4 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -59,7 +59,9 @@ def get_service_user(identifier, identifier_type='identity', service='nifi'): assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_users(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) + out = nipyapi.utils.filter_obj( + obj, identifier, identifier_type, greedy=False + ) return out @@ -160,7 +162,9 @@ def create_service_user_group(identity, service='nifi', if service == 'nifi': if users: - assert all(isinstance(user, nipyapi.nifi.UserEntity) for user in users) + assert all( + isinstance(user, nipyapi.nifi.UserEntity) for user in users + ) users_ids = [{'id': user.id} for user in users] user_group_obj = nipyapi.nifi.UserGroupEntity( revision=nipyapi.nifi.RevisionDTO( @@ -173,7 +177,9 @@ def create_service_user_group(identity, service='nifi', ) else: if users: - assert all(isinstance(user, nipyapi.registry.User) for user in users) + assert all( + isinstance(user, nipyapi.registry.User) for user in users + ) users_ids = [{'identifier': user.identifier} for user in users] user_group_obj = nipyapi.registry.UserGroup( identity=identity, @@ -227,7 +233,8 @@ def get_service_user_group(identifier, identifier_type='identity', assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_user_groups(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) + out = nipyapi.utils.filter_obj( + obj, identifier, identifier_type, greedy=False) return out diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 384cae35..95991c2c 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -355,12 +355,10 @@ def get_test_url_status(self): def set_container(self, container): self.container = container - def get_container(self): return self.container - def start_docker_containers(docker_containers, network_name='demo'): """ Deploys a list of DockerContainer's on a given network diff --git a/resources/client_gen/api_defs/nifi-1.12.1.json b/resources/client_gen/api_defs/nifi-1.12.1.json new file mode 100644 index 00000000..74089bd1 --- /dev/null +++ b/resources/client_gen/api_defs/nifi-1.12.1.json @@ -0,0 +1,21364 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and \n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", + "version" : "1.12.1", + "title" : "NiFi Rest Api", + "contact" : { + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-api", + "tags" : [ { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "connections", + "description" : "Endpoint for managing a Connection." + }, { + "name" : "controller", + "description" : "Provides realtime command and control of this NiFi instance" + }, { + "name" : "controller-services", + "description" : "Endpoint for managing a Controller Service." + }, { + "name" : "counters", + "description" : "Endpoint for managing counters." + }, { + "name" : "data-transfer", + "description" : "Supports data transfers with this NiFi using HTTP based site to site" + }, { + "name" : "flow", + "description" : "Endpoint for accessing the flow structure and component status." + }, { + "name" : "flowfile-queues", + "description" : "Endpoint for managing a FlowFile Queue." + }, { + "name" : "funnel", + "description" : "Endpoint for managing a Funnel." + }, { + "name" : "input-ports", + "description" : "Endpoint for managing an Input Port." + }, { + "name" : "labels", + "description" : "Endpoint for managing a Label." + }, { + "name" : "output-ports", + "description" : "Endpoint for managing an Output Port." + }, { + "name" : "parameter-contexts", + "description" : "Endpoint for managing version control for a flow" + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "process-groups", + "description" : "Endpoint for managing a Process Group." + }, { + "name" : "processors", + "description" : "Endpoint for managing a Processor." + }, { + "name" : "provenance", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "provenance-events", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "remote-process-groups", + "description" : "Endpoint for managing a Remote Process Group." + }, { + "name" : "reporting-tasks", + "description" : "Endpoint for managing a Reporting Task." + }, { + "name" : "resources", + "description" : "Provides the resources in this NiFi that can have access/authorization policies." + }, { + "name" : "site-to-site", + "description" : "Provide access to site to site with this NiFi" + }, { + "name" : "snippets", + "description" : "Endpoint for accessing dataflow snippets." + }, { + "name" : "system-diagnostics", + "description" : "Endpoint for accessing system diagnostics." + }, { + "name" : "templates", + "description" : "Endpoint for managing a Template." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + }, { + "name" : "versions", + "description" : "Endpoint for managing version control for a flow" + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Gets the status the client's access", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Unable to determine access status because the client could not be authenticated." + }, + "403" : { + "description" : "Unable to determine access status because the client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to determine access status because NiFi is not in the appropriate state." + }, + "500" : { + "description" : "Unable to determine access status because an unexpected error occurred." + } + } + } + }, + "/access/config" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Retrieves the access configuration for this NiFi", + "description" : "", + "operationId" : "getLoginConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessConfigurationEntity" + } + } + } + } + }, + "/access/download-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for downloading FlowFile content.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createDownloadToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/access/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", + "description" : "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 '.", + "operationId" : "createAccessTokenFromTicket", + "consumes" : [ "text/plain" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/knox/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/logout" : { + "delete" : { + "tags" : [ "access" ], + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOut", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/oidc/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/exchange" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcExchange", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + } + } + } + }, + "/access/oidc/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the OpenId Provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "oidcRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via username/password", + "description" : "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 '.", + "operationId" : "createAccessToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "username", + "in" : "formData", + "required" : false, + "type" : "string" + }, { + "name" : "password", + "in" : "formData", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/ui-extension-token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a single use access token for accessing a NiFi UI extension.", + "description" : "The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.", + "operationId" : "createUiExtensionToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create the download token because NiFi is not in the appropriate state. (i.e. may not have any tokens to grant or be configured to support username/password login)" + }, + "500" : { + "description" : "Unable to create download token because an unexpected error occurred." + } + } + } + }, + "/connections/{id}" : { + "get" : { + "tags" : [ "connections" ], + "summary" : "Gets a connection", + "description" : "", + "operationId" : "getConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source - /{component-type}/{uuid}" : [ ] + }, { + "Read Destination - /{component-type}/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "connections" ], + "summary" : "Updates a connection", + "description" : "", + "operationId" : "updateConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + }, { + "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] + }, { + "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] + } ] + }, + "delete" : { + "tags" : [ "connections" ], + "summary" : "Deletes a connection", + "description" : "", + "operationId" : "deleteConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller service", + "description" : "", + "operationId" : "updateControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller-services" ], + "summary" : "Deletes a controller service", + "description" : "", + "operationId" : "removeControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - Controller if scoped by Controller - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/descriptors" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name to return the descriptor for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/references" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerServiceReferences", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller services references", + "description" : "", + "operationId" : "updateControllerServiceReferences", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service request update request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] + } ] + } + }, + "/controller-services/{id}/run-status" : { + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates run status of a controller service", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets the state for a controller service", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "controller-services" ], + "summary" : "Clears the state for a controller service", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller/bulletin" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new bulletin", + "description" : "", + "operationId" : "createBulletin", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/cluster" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the contents of the cluster", + "description" : "Returns the contents of the cluster including all nodes and their status.", + "operationId" : "getCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + } + }, + "/controller/cluster/nodes/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a node in the cluster", + "description" : "", + "operationId" : "getNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a node in the cluster", + "description" : "", + "operationId" : "updateNode", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Removes a node from the cluster", + "description" : "", + "operationId" : "deleteNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/config" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi Controller", + "description" : "", + "operationId" : "getControllerConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi", + "description" : "", + "operationId" : "updateControllerConfig", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/controller-services" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/controller/history" : { + "delete" : { + "tags" : [ "controller" ], + "summary" : "Purges history", + "description" : "", + "operationId" : "deleteHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "endDate", + "in" : "query", + "description" : "Purge actions before this date/time.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the listing of available registry clients", + "description" : "", + "operationId" : "getRegistryClients", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new registry client", + "description" : "", + "operationId" : "createRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a registry client", + "description" : "", + "operationId" : "getRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a registry client", + "description" : "", + "operationId" : "updateRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Deletes a registry client", + "description" : "", + "operationId" : "deleteRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/reporting-tasks" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new reporting task", + "description" : "", + "operationId" : "createReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Reporting Task is restricted - /restricted-components" : [ ] + } ] + } + }, + "/counters" : { + "get" : { + "tags" : [ "counters" ], + "summary" : "Gets the current counters for this NiFi", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getCounters", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CountersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /counters" : [ ] + } ] + } + }, + "/counters/{id}" : { + "put" : { + "tags" : [ "counters" ], + "summary" : "Updates the specified counter. This will reset the counter value to 0", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateCounter", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The id of the counter.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CounterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /counters" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendInputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitInputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files to the input port", + "description" : "", + "operationId" : "receiveFlowFiles", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendOutputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitOutputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "checksum", + "in" : "query", + "description" : "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" : true, + "type" : "string" + }, { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { + "get" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files from the output port", + "description" : "", + "operationId" : "transferFlowFiles", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "There is no flow file to return.", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/{portType}/{portId}/transactions" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Create a transaction to the specified output port or input port", + "description" : "", + "operationId" : "createPortTransaction", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portType", + "in" : "path", + "description" : "The port type.", + "required" : true, + "type" : "string", + "enum" : [ "input-ports", "output-ports" ] + }, { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/about" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves details about this NiFi to put in the About dialog", + "description" : "", + "operationId" : "getAboutInfo", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AboutEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/banners" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the banners for this NiFi", + "description" : "", + "operationId" : "getBanners", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BannerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/bulletin-board" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets current bulletins", + "description" : "", + "operationId" : "getBulletinBoard", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "Includes bulletins with an id after this value.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceName", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose name match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "message", + "in" : "query", + "description" : "Includes bulletins whose message that match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "limit", + "in" : "query", + "description" : "The number of bulletins to limit the response to.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinBoardEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] + } ] + } + }, + "/flow/client-id" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Generates a client id.", + "description" : "", + "operationId" : "generateClientId", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Searches the cluster for a node with the specified address", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Node address to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterSearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/summary" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "The cluster summary for this NiFi", + "description" : "", + "operationId" : "getClusterSummary", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusteSummaryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/config" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the configuration for this NiFi flow", + "description" : "", + "operationId" : "getFlowConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/statistics" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets statistics for a connection", + "description" : "", + "operationId" : "getConnectionStatistics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the statistics.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatisticsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a connection", + "description" : "", + "operationId" : "getConnectionStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history for a connection", + "description" : "", + "operationId" : "getConnectionStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller-service-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of controller services that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getControllerServiceTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "serviceType", + "in" : "query", + "description" : "If specified, will only return controller services that are compatible with this type of service.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleGroup", + "in" : "query", + "description" : "If serviceType specified, is the bundle group of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleArtifact", + "in" : "query", + "description" : "If serviceType specified, is the bundle artifact of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleVersion", + "in" : "query", + "description" : "If serviceType specified, is the bundle version of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "typeFilter", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller/bulletins" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves Controller level bulletins", + "description" : "", + "operationId" : "getBulletins", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerBulletinsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /controller - For controller bulletins" : [ ] + }, { + "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] + }, { + "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] + } ] + } + }, + "/flow/controller/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets controller services for reporting tasks", + "description" : "", + "operationId" : "getControllerServicesFromController", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/current-user" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the user identity of the user making the request", + "description" : "", + "operationId" : "getCurrentUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUserEntity" + } + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "queryHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "The offset into the result set.", + "required" : true, + "type" : "string" + }, { + "name" : "count", + "in" : "query", + "description" : "The number of actions to return.", + "required" : true, + "type" : "string" + }, { + "name" : "sortColumn", + "in" : "query", + "description" : "The field to sort on.", + "required" : false, + "type" : "string" + }, { + "name" : "sortOrder", + "in" : "query", + "description" : "The direction to sort.", + "required" : false, + "type" : "string" + }, { + "name" : "startDate", + "in" : "query", + "description" : "Include actions after this date.", + "required" : false, + "type" : "string" + }, { + "name" : "endDate", + "in" : "query", + "description" : "Include actions before this date.", + "required" : false, + "type" : "string" + }, { + "name" : "userIdentity", + "in" : "query", + "description" : "Include actions performed by this user.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Include actions on this component.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history/components/{componentId}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history for a component", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getComponentHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "componentId", + "in" : "path", + "description" : "The component id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read underlying component - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/history/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets an action", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAction", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The action id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/input-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an input port", + "description" : "", + "operationId" : "getInputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/metrics/{producer}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all metrics for the flow from a particular node", + "description" : "", + "operationId" : "getFlowMetrics", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "producer", + "in" : "path", + "description" : "The producer for flow file metrics. Each producer may have its own output format.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/output-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an output port", + "description" : "", + "operationId" : "getOutputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/parameter-contexts" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all Parameter Contexts", + "description" : "", + "operationId" : "getParameterContexts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] + } ] + } + }, + "/flow/prioritizers" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of prioritizers that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getPrioritizers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PrioritizerTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupFlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Schedule or unschedule components in the specified Process Group.", + "description" : "", + "operationId" : "scheduleComponents", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all controller services", + "description" : "", + "operationId" : "getControllerServicesFromGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include parent/ancestory process groups", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Enable or disable Controller Services in the specified Process Group.", + "description" : "", + "operationId" : "activateControllerServices", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status for a process group", + "description" : "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.", + "operationId" : "getProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "recursive", + "in" : "query", + "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a remote process group", + "description" : "", + "operationId" : "getProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processor-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of processors that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a processor", + "description" : "", + "operationId" : "getProcessorStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a processor", + "description" : "", + "operationId" : "getProcessorStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the listing of available registries", + "description" : "", + "operationId" : "getRegistries", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{id}/buckets" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the buckets from the specified registry for the current user", + "description" : "", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BucketsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flows from the specified registry and bucket for the current user", + "description" : "", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", + "description" : "", + "operationId" : "getVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + }, { + "name" : "flow-id", + "in" : "path", + "description" : "The flow id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history", + "description" : "", + "operationId" : "getRemoteProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-task-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of reporting tasks that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReportingTaskTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-tasks" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all reporting tasks", + "description" : "", + "operationId" : "getReportingTasks", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTasksEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Performs a search against this NiFi using the specified search term", + "description" : "Only search results from authorized components will be returned.", + "operationId" : "searchFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "a", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the current status of this NiFi", + "description" : "", + "operationId" : "getControllerStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/templates" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all templates", + "description" : "", + "operationId" : "getTemplates", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplatesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Creates a request to drop the contents of the queue in this connection.", + "description" : "", + "operationId" : "createDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a drop request for the specified connection.", + "description" : "", + "operationId" : "getDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to drop the contents of this connection.", + "description" : "", + "operationId" : "removeDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets a FlowFile from a Connection.", + "description" : "", + "operationId" : "getFlowFile", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowFileEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the content for a FlowFile in a Connection.", + "description" : "", + "operationId" : "downloadFlowFileContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Lists the contents of the queue in this connection.", + "description" : "", + "operationId" : "createFlowFileListing", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a listing request for the specified connection.", + "description" : "", + "operationId" : "getListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to list the contents of this connection.", + "description" : "", + "operationId" : "deleteListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/funnels/{id}" : { + "get" : { + "tags" : [ "funnel" ], + "summary" : "Gets a funnel", + "description" : "", + "operationId" : "getFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /funnels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "funnel" ], + "summary" : "Updates a funnel", + "description" : "", + "operationId" : "updateFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "funnel" ], + "summary" : "Deletes a funnel", + "description" : "", + "operationId" : "removeFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}" : { + "get" : { + "tags" : [ "input-ports" ], + "summary" : "Gets an input port", + "description" : "", + "operationId" : "getInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /input-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates an input port", + "description" : "", + "operationId" : "updateInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "input-ports" ], + "summary" : "Deletes an input port", + "description" : "", + "operationId" : "removeInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}/run-status" : { + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates run status of an input-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] + } ] + } + }, + "/labels/{id}" : { + "get" : { + "tags" : [ "labels" ], + "summary" : "Gets a label", + "description" : "", + "operationId" : "getLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /labels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "labels" ], + "summary" : "Updates a label", + "description" : "", + "operationId" : "updateLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "labels" ], + "summary" : "Deletes a label", + "description" : "", + "operationId" : "removeLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}" : { + "get" : { + "tags" : [ "output-ports" ], + "summary" : "Gets an output port", + "description" : "", + "operationId" : "getOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /output-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates an output port", + "description" : "", + "operationId" : "updateOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "output-ports" ], + "summary" : "Deletes an output port", + "description" : "", + "operationId" : "removeOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}/run-status" : { + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates run status of an output-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] + } ] + } + }, + "/parameter-contexts" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Create a Parameter Context", + "description" : "", + "operationId" : "createParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The Parameter Context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-contexts" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate the Update Request of a Parameter Context", + "description" : "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 acttion 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}.", + "operationId" : "submitParameterContextUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated version of the parameter context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Write - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests/{requestId}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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. ", + "operationId" : "getParameterContextUpdate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the ParameterContext", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", + "description" : "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}.", + "operationId" : "submitValidationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The validation request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Validation Request with the given ID", + "description" : "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. ", + "operationId" : "getValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Validation Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Validation Request with the given ID", + "description" : "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.", + "operationId" : "deleteValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Parameter Context with the given ID", + "description" : "Returns the Parameter Context with the given ID.", + "operationId" : "getParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ] + }, + "put" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Modifies a Parameter Context", + "description" : "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.", + "operationId" : "updateParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated Parameter Context", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + }, { + "Write - /parameter-contexts/{id}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Parameter Context with the given ID", + "description" : "Deletes the Parameter Context with the given ID.", + "operationId" : "deleteParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The Parameter Context ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{uuid}" : [ ] + }, { + "Write - /parameter-contexts/{uuid}" : [ ] + }, { + "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + }, { + "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + } ] + } + }, + "/policies" : { + "post" : { + "tags" : [ "policies" ], + "summary" : "Creates an access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy for the specified action and resource", + "description" : "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.", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Updates a access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Deletes an access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + }, { + "Write - Policy of the parent resource - /policies/{resource}" : [ ] + } ] + } + }, + "/process-groups/replace-requests/{id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Returns the Replace Request with the given ID", + "description" : "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.", + "operationId" : "getReplaceProcessGroupRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Replace Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes the Replace Request with the given ID", + "description" : "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.", + "operationId" : "deleteReplaceProcessGroupRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates a process group", + "description" : "", + "operationId" : "updateProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes a process group", + "description" : "", + "operationId" : "removeProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/connections" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all connections", + "description" : "", + "operationId" : "getConnections", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a connection", + "description" : "", + "operationId" : "createConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/controller-services" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/download" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group for download", + "description" : "", + "operationId" : "exportProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/empty-all-connections-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", + "description" : "", + "operationId" : "createEmptyAllConnectionsRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "202" : { + "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ] + } + }, + "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets the current status of a drop all flowfiles request.", + "description" : "", + "operationId" : "getDropAllFlowfilesRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Cancels and/or removes a request to drop all flowfiles.", + "description" : "", + "operationId" : "removeDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ] + } + }, + "/process-groups/{id}/flow-contents" : { + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", + "description" : "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.", + "operationId" : "replaceProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group replace request entity.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupImportEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupImportEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/funnels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all funnels", + "description" : "", + "operationId" : "getFunnels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a funnel", + "description" : "", + "operationId" : "createFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/input-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all input ports", + "description" : "", + "operationId" : "getInputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/InputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an input port", + "description" : "", + "operationId" : "createInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/labels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all labels", + "description" : "", + "operationId" : "getLabels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a label", + "description" : "", + "operationId" : "createLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/local-modifications" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", + "description" : "", + "operationId" : "getLocalModifications", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowComparisonEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/output-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all output ports", + "description" : "", + "operationId" : "getOutputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/OutputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an output port", + "description" : "", + "operationId" : "createOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all process groups", + "description" : "", + "operationId" : "getProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a process group", + "description" : "", + "operationId" : "createProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/processors" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all processors", + "description" : "", + "operationId" : "getProcessors", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include processors from descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new processor", + "description" : "", + "operationId" : "createProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Processor is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/remote-process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all remote process groups", + "description" : "", + "operationId" : "getRemoteProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new process group", + "description" : "", + "operationId" : "createRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/replace-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Initiate the Replace Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateReplaceProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group replace request entity", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupImportEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/process-groups/{id}/snippet-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Copies a snippet and discards it.", + "description" : "", + "operationId" : "copySnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The copy snippet request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CopySnippetRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + }, { + "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/template-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Instantiates a template", + "description" : "", + "operationId" : "instantiateTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The instantiate template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/InstantiateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /templates/{uuid}" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a template and discards the specified snippet.", + "description" : "", + "operationId" : "createTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The create template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/import" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Imports a template", + "description" : "", + "operationId" : "importTemplate", + "consumes" : [ "application/xml" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/upload" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Uploads a template", + "description" : "", + "operationId" : "uploadTemplate", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "schema" : { + "type" : "boolean" + } + }, { + "name" : "template", + "in" : "formData", + "description" : "The binary content of the template file being uploaded.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistry", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include ancestor groups", + "required" : false, + "type" : "boolean", + "default" : true + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates the contents of a Process Group's variable Registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVariableRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry/update-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Submits a request to update a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "submitUpdateVariableRegistryRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/processors/run-status-details/queries" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", + "description" : "", + "operationId" : "getProcessorRunStatusDetails", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The request for the processors that should be included in the results", + "required" : false, + "schema" : { + "$ref" : "#/definitions/RunStatusDetailsRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] + } ] + } + }, + "/processors/{id}" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets a processor", + "description" : "", + "operationId" : "getProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates a processor", + "description" : "", + "operationId" : "updateProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "processors" ], + "summary" : "Deletes a processor", + "description" : "", + "operationId" : "deleteProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/descriptors" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the descriptor for a processor property", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/diagnostics" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets diagnostics information about a processor", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/run-status" : { + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates run status of a processor", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the state for a processor", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Clears the state for a processor", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/threads" : { + "delete" : { + "tags" : [ "processors" ], + "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", + "description" : "", + "operationId" : "terminateProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/provenance" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a provenance query", + "description" : "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.", + "operationId" : "submitProvenanceRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The provenance query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/replays" : { + "post" : { + "tags" : [ "provenance-events" ], + "summary" : "Replays content from a provenance event", + "description" : "", + "operationId" : "submitReplay", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The replay request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SubmitReplayRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets a provenance event", + "description" : "", + "operationId" : "getProvenanceEvent", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this event exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/input" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the input content for a provenance event", + "description" : "", + "operationId" : "getInputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/output" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the output content for a provenance event", + "description" : "", + "operationId" : "getOutputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a lineage query", + "description" : "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.", + "operationId" : "submitLineageRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The lineage query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a lineage query", + "description" : "", + "operationId" : "getLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a lineage query", + "description" : "", + "operationId" : "deleteLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/search-options" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets the searchable attributes for provenance events", + "description" : "", + "operationId" : "getSearchOptions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceOptionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a provenance query", + "description" : "", + "operationId" : "getProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "summarize", + "in" : "query", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "incrementalResults", + "in" : "query", + "description" : "Whether or not to summarize provenance events returned. This property is false by default.", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a provenance query", + "description" : "", + "operationId" : "deleteProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/remote-process-groups/{id}" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Deletes a remote process group", + "description" : "", + "operationId" : "removeRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroupRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/state" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets the state for a RemoteProcessGroup", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task", + "description" : "", + "operationId" : "getReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates a reporting task", + "description" : "", + "operationId" : "updateReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Deletes a reporting task", + "description" : "", + "operationId" : "removeReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/descriptors" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/run-status" : { + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates run status of a reporting task", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets the state for a reporting task", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Clears the state for a reporting task", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/resources" : { + "get" : { + "tags" : [ "resources" ], + "summary" : "Gets the available resources that support access/authorization policies", + "description" : "", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ResourcesEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /resources" : [ ] + } ] + } + }, + "/site-to-site" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the details about this NiFi necessary to communicate via site to site", + "description" : "", + "operationId" : "getSiteToSiteDetails", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/site-to-site/peers" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the available Peers and its status of this NiFi", + "description" : "", + "operationId" : "getPeers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json", "application/xml" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PeersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/snippets" : { + "post" : { + "tags" : [ "snippets" ], + "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", + "description" : "", + "operationId" : "createSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] + } ] + } + }, + "/snippets/{id}" : { + "put" : { + "tags" : [ "snippets" ], + "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", + "description" : "", + "operationId" : "updateSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + } ] + }, + "delete" : { + "tags" : [ "snippets" ], + "summary" : "Deletes the components in a snippet and discards the snippet", + "description" : "", + "operationId" : "deleteSnippet", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/system-diagnostics" : { + "get" : { + "tags" : [ "system-diagnostics" ], + "summary" : "Gets the diagnostics for the system NiFi is running on", + "description" : "", + "operationId" : "getSystemDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SystemDiagnosticsEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ] + } + }, + "/templates/{id}" : { + "delete" : { + "tags" : [ "templates" ], + "summary" : "Deletes a template", + "description" : "", + "operationId" : "removeTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /templates/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/templates/{id}/download" : { + "get" : { + "tags" : [ "templates" ], + "summary" : "Exports a template", + "description" : "", + "operationId" : "exportTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /templates/{uuid}" : [ ] + } ] + } + }, + "/tenants/search-results" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Searches for a tenant with the specified identity", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchTenants", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Identity to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TenantsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all user groups", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all users", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UsersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/versions/active-requests" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Create a version control request", + "description" : "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.", + "operationId" : "createVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateActiveRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/active-requests/{id}" : { + "put" : { + "tags" : [ "versions" ], + "summary" : "Updates the request with the given ID", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The version control component mapping.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlComponentMappingEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can update it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the version control request with the given ID", + "description" : "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.", + "operationId" : "deleteVersionControlRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/process-groups/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the Version Control information for a process group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVersionInformation", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "versions" ], + "summary" : "Save the Process Group with the given ID", + "description" : "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.", + "operationId" : "saveToFlowRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/StartVersionControlRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "versions" ], + "summary" : "Update the version of a Process Group with the given ID", + "description" : "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.", + "operationId" : "updateFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Stops version controlling the Process Group with the given ID", + "description" : "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.", + "operationId" : "stopVersionControl", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/process-groups/{id}/download" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the latest version of a Process Group for download", + "description" : "", + "operationId" : "exportFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/revert-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Revert Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateRevertFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/revert-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Revert Request with the given ID", + "description" : "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.", + "operationId" : "getRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Revert Request with the given ID", + "description" : "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.", + "operationId" : "deleteRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/update-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Update Request of a Process Group with the given ID", + "description" : "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.", + "operationId" : "initiateVersionControlUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/update-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "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.", + "operationId" : "getUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "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.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + } + }, + "definitions" : { + "AboutDTO" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "The title to be used on the page and in the about dialog." + }, + "version" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "uri" : { + "type" : "string", + "description" : "The URI for the NiFi." + }, + "contentViewerUrl" : { + "type" : "string", + "description" : "The URL for the content viewer if configured." + }, + "timezone" : { + "type" : "string", + "description" : "The timezone of the NiFi instance.", + "readOnly" : true + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "description" : "Build timestamp" + } + } + }, + "AboutEntity" : { + "type" : "object", + "properties" : { + "about" : { + "$ref" : "#/definitions/AboutDTO" + } + }, + "xml" : { + "name" : "aboutEntity" + } + }, + "AccessConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsLogin" : { + "type" : "boolean", + "description" : "Indicates whether or not this NiFi supports user login.", + "readOnly" : true + } + } + }, + "AccessConfigurationEntity" : { + "type" : "object", + "properties" : { + "config" : { + "$ref" : "#/definitions/AccessConfigurationDTO" + } + }, + "xml" : { + "name" : "accessConfigurationEntity" + } + }, + "AccessPolicyDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + } + }, + "AccessPolicyEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicyDTO" + } + }, + "xml" : { + "name" : "accessPolicyEntity" + } + }, + "AccessPolicySummaryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + } + } + }, + "AccessPolicySummaryEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicySummaryDTO" + } + }, + "xml" : { + "name" : "accessPolicySummaryEntity" + } + }, + "AccessStatusDTO" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The user access status.", + "readOnly" : true + }, + "message" : { + "type" : "string", + "description" : "Additional details about the user access status.", + "readOnly" : true + } + }, + "xml" : { + "name" : "accessStatus" + } + }, + "AccessStatusEntity" : { + "type" : "object", + "properties" : { + "accessStatus" : { + "$ref" : "#/definitions/AccessStatusDTO" + } + }, + "xml" : { + "name" : "accessStatusEntity" + } + }, + "ActionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32", + "description" : "The action id." + }, + "userIdentity" : { + "type" : "string", + "description" : "The identity of the user that performed the action." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of the source component." + }, + "componentDetails" : { + "description" : "The details of the source component.", + "$ref" : "#/definitions/ComponentDetailsDTO" + }, + "operation" : { + "type" : "string", + "description" : "The operation that was performed." + }, + "actionDetails" : { + "description" : "The details of the action.", + "$ref" : "#/definitions/ActionDetailsDTO" + } + } + }, + "ActionDetailsDTO" : { + "type" : "object" + }, + "ActionEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "action" : { + "$ref" : "#/definitions/ActionDTO" + } + }, + "xml" : { + "name" : "actionEntity" + } + }, + "ActivateControllerServicesEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "activateControllerServicesEntity" + } + }, + "AffectedComponentDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + } + } + }, + "AffectedComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AffectedComponentDTO" + }, + "processGroup" : { + "description" : "The Process Group that the component belongs to", + "$ref" : "#/definitions/ProcessGroupNameDTO" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of component referenced", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + } + }, + "xml" : { + "name" : "affectedComponentEntity" + } + }, + "AllowableValueDTO" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "A human readable value that is allowed for the property descriptor." + }, + "value" : { + "type" : "string", + "description" : "A value that is allowed for the property descriptor." + }, + "description" : { + "type" : "string", + "description" : "A description for this allowable value." + } + } + }, + "AllowableValueEntity" : { + "type" : "object", + "properties" : { + "allowableValue" : { + "$ref" : "#/definitions/AllowableValueDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "AttributeDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The attribute name." + }, + "value" : { + "type" : "string", + "description" : "The attribute value." + }, + "previousValue" : { + "type" : "string", + "description" : "The value of the attribute before the event took place." + } + } + }, + "BannerDTO" : { + "type" : "object", + "properties" : { + "headerText" : { + "type" : "string", + "description" : "The header text." + }, + "footerText" : { + "type" : "string", + "description" : "The footer text." + } + } + }, + "BannerEntity" : { + "type" : "object", + "properties" : { + "banners" : { + "$ref" : "#/definitions/BannerDTO" + } + }, + "xml" : { + "name" : "bannersEntity" + } + }, + "BatchSettingsDTO" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "Bucket" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket." + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "readOnly" : true, + "minimum" : 1 + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "allowBundleRedeploy" : { + "type" : "boolean", + "description" : "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." + }, + "allowPublicRead" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" + }, + "permissions" : { + "description" : "The access that the current user has to this bucket.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "BucketDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The bucket identifier" + }, + "name" : { + "type" : "string", + "description" : "The bucket name" + }, + "description" : { + "type" : "string", + "description" : "The bucket description" + }, + "created" : { + "type" : "integer", + "format" : "int64", + "description" : "The created timestamp of this bucket" + } + } + }, + "BucketEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "bucket" : { + "$ref" : "#/definitions/BucketDTO" + }, + "permissions" : { + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "bucketEntity" + } + }, + "BucketsEntity" : { + "type" : "object", + "properties" : { + "buckets" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BucketEntity" + } + } + }, + "xml" : { + "name" : "bucketsEntity" + } + }, + "BulletinBoardDTO" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins in the bulletin board, that matches the supplied request.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp when this report was generated." + } + } + }, + "BulletinBoardEntity" : { + "type" : "object", + "properties" : { + "bulletinBoard" : { + "$ref" : "#/definitions/BulletinBoardDTO" + } + }, + "xml" : { + "name" : "bulletinBoardEntity" + } + }, + "BulletinDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "description" : "The id of the bulletin." + }, + "nodeAddress" : { + "type" : "string", + "description" : "If clustered, the address of the node from which the bulletin originated." + }, + "category" : { + "type" : "string", + "description" : "The category of this bulletin." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the source component." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "level" : { + "type" : "string", + "description" : "The level of the bulletin." + }, + "message" : { + "type" : "string", + "description" : "The bulletin message." + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + } + } + }, + "BulletinEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "groupId" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + }, + "nodeAddress" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "bulletin" : { + "$ref" : "#/definitions/BulletinDTO" + } + }, + "xml" : { + "name" : "bulletinEntity" + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleDTO" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle." + } + } + }, + "ClusteSummaryEntity" : { + "type" : "object", + "properties" : { + "clusterSummary" : { + "$ref" : "#/definitions/ClusterSummaryDTO" + } + }, + "xml" : { + "name" : "clusterSummaryEntity" + } + }, + "ClusterDTO" : { + "type" : "object", + "properties" : { + "nodes" : { + "type" : "array", + "description" : "The collection of nodes that are part of the cluster.", + "items" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp the report was generated." + } + } + }, + "ClusterEntity" : { + "type" : "object", + "properties" : { + "cluster" : { + "$ref" : "#/definitions/ClusterDTO" + } + }, + "xml" : { + "name" : "clusterEntity" + } + }, + "ClusterSearchResultsEntity" : { + "type" : "object", + "properties" : { + "nodeResults" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NodeSearchResultDTO" + } + } + }, + "xml" : { + "name" : "clusterSearchResultsEntity" + } + }, + "ClusterSummaryDTO" : { + "type" : "object", + "properties" : { + "connectedNodes" : { + "type" : "string", + "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." + }, + "connectedNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes that are currently connected to the cluster" + }, + "totalNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" + }, + "clustered" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is clustered." + }, + "connectedToCluster" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is connected to a cluster." + } + } + }, + "ComponentDetailsDTO" : { + "type" : "object" + }, + "ComponentDifferenceDTO" : { + "type" : "object", + "properties" : { + "componentType" : { + "type" : "string", + "description" : "The type of component" + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the component belongs to" + }, + "differences" : { + "type" : "array", + "description" : "The differences in the component between the two flows", + "items" : { + "$ref" : "#/definitions/DifferenceDTO" + } + } + } + }, + "ComponentHistoryDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component id." + }, + "propertyHistory" : { + "type" : "object", + "description" : "The history for the properties of the component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyHistoryDTO" + } + } + } + }, + "ComponentHistoryEntity" : { + "type" : "object", + "properties" : { + "componentHistory" : { + "$ref" : "#/definitions/ComponentHistoryDTO" + } + }, + "xml" : { + "name" : "componentHistoryEntity" + } + }, + "ComponentReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component." + } + } + }, + "ComponentReferenceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "component" : { + "$ref" : "#/definitions/ComponentReferenceDTO" + } + }, + "xml" : { + "name" : "componentReferenceEntity" + } + }, + "ComponentRestrictionPermissionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "permissions" : { + "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + } + } + }, + "ComponentSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component that matched the search." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the component that matched the search." + }, + "parentGroup" : { + "description" : "The parent group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "versionedGroup" : { + "description" : "The nearest versioned ancestor group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component that matched the search." + }, + "matches" : { + "type" : "array", + "description" : "What matched the search from the component.", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentStateDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component identifier." + }, + "stateDescription" : { + "type" : "string", + "description" : "Description of the state this component persists." + }, + "clusterState" : { + "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", + "$ref" : "#/definitions/StateMapDTO" + }, + "localState" : { + "description" : "The local state for this component.", + "$ref" : "#/definitions/StateMapDTO" + } + } + }, + "ComponentStateEntity" : { + "type" : "object", + "properties" : { + "componentState" : { + "description" : "The component state.", + "$ref" : "#/definitions/ComponentStateDTO" + } + }, + "xml" : { + "name" : "componentStateEntity" + } + }, + "ComponentValidationResultDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "currentlyValid" : { + "type" : "boolean", + "description" : "Whether or not the component is currently valid" + }, + "resultsValid" : { + "type" : "boolean", + "description" : "Whether or not the component will be valid if the Parameter Context is changed" + }, + "resultantValidationErrors" : { + "type" : "array", + "description" : "The validation errors that will apply to the component if the Parameter Context is changed", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentValidationResultEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ComponentValidationResultDTO" + } + }, + "xml" : { + "name" : "componentValidationResultEntity" + } + }, + "ComponentValidationResultsEntity" : { + "type" : "object", + "properties" : { + "validationResults" : { + "type" : "array", + "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", + "items" : { + "$ref" : "#/definitions/ComponentValidationResultEntity" + } + } + }, + "xml" : { + "name" : "componentValidationResults" + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectableDTO" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "running" : { + "type" : "boolean", + "description" : "Reflects the current state of the connectable component." + }, + "transmitting" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." + }, + "exists" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target exists." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "availableRelationships" : { + "type" : "array", + "description" : "The relationships that the source of the connection currently supports.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "How to load balance the data in this Connection across the nodes in the cluster.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "loadBalancePartitionAttribute" : { + "type" : "string", + "description" : "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" + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "loadBalanceStatus" : { + "type" : "string", + "description" : "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.", + "readOnly" : true, + "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] + } + } + }, + "ConnectionEntity" : { + "type" : "object", + "required" : [ "destinationType", "sourceType" ], + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ConnectionDTO" + }, + "status" : { + "description" : "The status of the connection.", + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The identifier of the source of this connection." + }, + "sourceGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the source of this connection." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of component the source connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "destinationId" : { + "type" : "string", + "description" : "The identifier of the destination of this connection." + }, + "destinationGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the destination of this connection." + }, + "destinationType" : { + "type" : "string", + "description" : "The type of component the destination connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + } + }, + "xml" : { + "name" : "connectionEntity" + } + }, + "ConnectionStatisticsDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" + } + } + } + }, + "ConnectionStatisticsEntity" : { + "type" : "object", + "properties" : { + "connectionStatistics" : { + "$ref" : "#/definitions/ConnectionStatisticsDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatisticsEntity" + } + }, + "ConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of queued objects at the next configured interval." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." + }, + "predictionIntervalMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The prediction interval in seconds" + } + } + }, + "ConnectionStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the connection belongs to" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "sourceId" : { + "type" : "string", + "description" : "The ID of the source component" + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component" + }, + "destinationId" : { + "type" : "string", + "description" : "The ID of the destination component" + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination component" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" + } + } + } + }, + "ConnectionStatusEntity" : { + "type" : "object", + "properties" : { + "connectionStatus" : { + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatusEntity" + } + }, + "ConnectionStatusPredictionsSnapshotDTO" : { + "type" : "object", + "properties" : { + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictionIntervalSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the process group the connection belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source of the connection." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source of the connection." + }, + "destinationId" : { + "type" : "string", + "description" : "The id of the destination of the connection." + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination of the connection." + }, + "predictions" : { + "description" : "Predictions, if available, for this connection (null if not available)", + "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have left the connection in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are currently queued in the connection." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that are currently queued in the connection." + }, + "queued" : { + "type" : "string", + "description" : "The total count and size of queued flowfiles formatted." + }, + "queuedSize" : { + "type" : "string", + "description" : "The total size of flowfiles that are queued formatted." + }, + "queuedCount" : { + "type" : "string", + "description" : "The number of flowfiles that are queued, pretty printed." + }, + "percentUseCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "percentUseBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "connectionStatusSnapshot" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ConnectionsEntity" : { + "type" : "object", + "properties" : { + "connections" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } + }, + "xml" : { + "name" : "connectionsEntity" + } + }, + "ControllerBulletinsEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "System level bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "controllerServiceBulletins" : { + "type" : "array", + "description" : "Controller service bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "reportingTaskBulletins" : { + "type" : "array", + "description" : "Reporting task bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerConfigurationDTO" : { + "type" : "object", + "properties" : { + "maxTimerDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of timer driven threads the NiFi has available." + }, + "maxEventDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of event driven threads the NiFi has available." + } + } + }, + "ControllerConfigurationEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/ControllerConfigurationDTO" + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the NiFi." + }, + "name" : { + "type" : "string", + "description" : "The name of the NiFi." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the NiFi." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports contained in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports contained in the NiFi." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports contained in the NiFi." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the NiFi." + }, + "remoteSiteListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "remoteSiteHttpListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "siteToSiteSecure" : { + "type" : "boolean", + "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." + }, + "instanceId" : { + "type" : "string", + "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports available to send data to for the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports available to received data from the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + } + } + }, + "ControllerEntity" : { + "type" : "object", + "properties" : { + "controller" : { + "$ref" : "#/definitions/ControllerDTO" + } + }, + "xml" : { + "name" : "controllerEntity" + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceApiDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "ControllerServiceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the controller service." + }, + "state" : { + "type" : "string", + "description" : "The state of the controller service.", + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the controller service persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the controller service requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the ontroller service has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the controller service has multiple versions available." + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the controller service properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the controller services custom configuration UI if applicable." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "referencingComponents" : { + "type" : "array", + "description" : "All components referencing this controller service.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ControllerServiceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this ControllerService." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ControllerService.", + "readOnly" : true, + "$ref" : "#/definitions/ControllerServiceStatusDTO" + } + }, + "xml" : { + "name" : "controllerServiceEntity" + } + }, + "ControllerServiceReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "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." + }, + "id" : { + "type" : "string", + "description" : "The id of the component referencing a controller service." + }, + "name" : { + "type" : "string", + "description" : "The name of the component referencing a controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the component referencing a controller service in simple Java class name format without package name." + }, + "state" : { + "type" : "string", + "description" : "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." + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the component properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "referenceType" : { + "type" : "string", + "description" : "The type of reference this is.", + "enum" : [ "Processor", "ControllerService", "ReportingTask" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "referenceCycle" : { + "type" : "boolean", + "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." + }, + "referencingComponents" : { + "type" : "array", + "description" : "If the referencing component represents a controller service, these are the components that reference it.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + } + }, + "ControllerServiceReferencingComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentEntity" + } + }, + "ControllerServiceReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "controllerServiceReferencingComponents" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentsEntity" + } + }, + "ControllerServiceRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ControllerService.", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ControllerServiceStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ControllerService", + "readOnly" : true, + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ControllerServiceTypesEntity" : { + "type" : "object", + "properties" : { + "controllerServiceTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "controllerServiceTypesEntity" + } + }, + "ControllerServicesEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "controllerServices" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } + }, + "xml" : { + "name" : "controllerServicesEntity" + } + }, + "ControllerStatusDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads in the NiFi." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of terminated threads in the NiFi." + }, + "queued" : { + "type" : "string", + "description" : "The number of flowfiles queued in the NiFi." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles queued across the entire flow" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles queued across the entire flow" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the NiFi." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the NiFi." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the NiFi." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the NiFi." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the NiFi." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." + } + } + }, + "ControllerStatusEntity" : { + "type" : "object", + "properties" : { + "controllerStatus" : { + "$ref" : "#/definitions/ControllerStatusDTO" + } + }, + "xml" : { + "name" : "controllerStatusEntity" + } + }, + "CopySnippetRequestEntity" : { + "type" : "object", + "properties" : { + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "CounterDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the counter." + }, + "context" : { + "type" : "string", + "description" : "The context of the counter." + }, + "name" : { + "type" : "string", + "description" : "The name of the counter." + }, + "valueCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The value count." + }, + "value" : { + "type" : "string", + "description" : "The value of the counter." + } + } + }, + "CounterEntity" : { + "type" : "object", + "properties" : { + "counter" : { + "$ref" : "#/definitions/CounterDTO" + } + }, + "xml" : { + "name" : "counterEntity" + } + }, + "CountersDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/CountersSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeCountersSnapshotDTO" + } + } + } + }, + "CountersEntity" : { + "type" : "object", + "properties" : { + "counters" : { + "$ref" : "#/definitions/CountersDTO" + } + }, + "xml" : { + "name" : "countersEntity" + } + }, + "CountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "counters" : { + "type" : "array", + "description" : "All counters in the NiFi.", + "items" : { + "$ref" : "#/definitions/CounterDTO" + } + } + } + }, + "CreateActiveRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The Process Group ID that this active request will update" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createActiveRequestEntity" + } + }, + "CreateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createTemplateRequestEntity" + } + }, + "CurrentUserEntity" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity being serialized." + }, + "anonymous" : { + "type" : "boolean", + "description" : "Whether the current user is anonymous." + }, + "provenancePermissions" : { + "description" : "Permissions for querying provenance.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "countersPermissions" : { + "description" : "Permissions for accessing counters.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "tenantsPermissions" : { + "description" : "Permissions for accessing tenants.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "controllerPermissions" : { + "description" : "Permissions for accessing the controller.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "policiesPermissions" : { + "description" : "Permissions for accessing the policies.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "systemPermissions" : { + "description" : "Permissions for accessing system.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "parameterContextPermissions" : { + "description" : "Permissions for accessing parameter contexts.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "restrictedComponentsPermissions" : { + "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "componentRestrictionPermissions" : { + "type" : "array", + "description" : "Permissions for specific component restrictions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" + } + }, + "canVersionFlows" : { + "type" : "boolean", + "description" : "Whether the current user can version flows." + } + }, + "xml" : { + "name" : "currentEntity" + } + }, + "DifferenceDTO" : { + "type" : "object", + "properties" : { + "differenceType" : { + "type" : "string", + "description" : "The type of difference" + }, + "difference" : { + "type" : "string", + "description" : "Description of the difference" + } + } + }, + "DimensionsDTO" : { + "type" : "object", + "properties" : { + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + } + } + }, + "DocumentedTypeDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the type." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "If this type represents a ControllerService, this lists the APIs it implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the type." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether this type is restricted." + }, + "usageRestriction" : { + "type" : "string", + "description" : "The optional description of why the usage of this component is restricted." + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExplicitRestrictionDTO" + } + }, + "deprecationReason" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted." + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "DropRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this drop request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this drop request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this drop request failed." + }, + "currentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files currently queued." + }, + "currentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files currently queued in bytes." + }, + "current" : { + "type" : "string", + "description" : "The count and size of flow files currently queued." + }, + "originalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files to be dropped as a result of this request." + }, + "originalSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files to be dropped as a result of this request in bytes." + }, + "original" : { + "type" : "string", + "description" : "The count and size of flow files to be dropped as a result of this request." + }, + "droppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files that have been dropped thus far." + }, + "droppedSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files that have been dropped thus far in bytes." + }, + "dropped" : { + "type" : "string", + "description" : "The count and size of flow files that have been dropped thus far." + }, + "state" : { + "type" : "string", + "description" : "The current state of the drop request." + } + } + }, + "DropRequestEntity" : { + "type" : "object", + "properties" : { + "dropRequest" : { + "$ref" : "#/definitions/DropRequestDTO" + } + }, + "xml" : { + "name" : "dropRequestEntity" + } + }, + "ExplicitRestrictionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "explanation" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted for this required permission." + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "FlowBreadcrumbDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The id of the group." + }, + "versionControlInformation" : { + "description" : "The process group version control information or null if not version controlled.", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "FlowBreadcrumbEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this ancestor ProcessGroup." + }, + "permissions" : { + "description" : "The permissions for this ancestor ProcessGroup.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "breadcrumb" : { + "description" : "This breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbDTO" + }, + "parentBreadcrumb" : { + "description" : "The parent breadcrumb for this breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowComparisonEntity" : { + "type" : "object", + "properties" : { + "componentDifferences" : { + "type" : "array", + "description" : "The list of differences for each component in the flow that is not the same between the two flows", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceDTO" + } + } + }, + "xml" : { + "name" : "flowComparisonEntity" + } + }, + "FlowConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi supports configurable users and groups.", + "readOnly" : true + }, + "autoRefreshIntervalSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "The interval in seconds between the automatic NiFi refresh requests.", + "readOnly" : true + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the system." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The default back pressure object threshold." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The default back pressure data size threshold." + } + } + }, + "FlowConfigurationEntity" : { + "type" : "object", + "properties" : { + "flowConfiguration" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/FlowConfigurationDTO" + } + }, + "xml" : { + "name" : "flowConfigurationEntity" + } + }, + "FlowDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + } + }, + "FlowEntity" : { + "type" : "object", + "properties" : { + "flow" : { + "$ref" : "#/definitions/FlowDTO" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowFileDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "attributes" : { + "type" : "object", + "description" : "The FlowFile attributes.", + "additionalProperties" : { + "type" : "string" + } + }, + "contentClaimSection" : { + "type" : "string", + "description" : "The section in which the content claim lives." + }, + "contentClaimContainer" : { + "type" : "string", + "description" : "The container in which the content claim lives." + }, + "contentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the content claim." + }, + "contentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the content claim where the flowfile's content begins." + }, + "contentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the content claim formatted." + }, + "contentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the content claim in bytes." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowFileEntity" : { + "type" : "object", + "properties" : { + "flowFile" : { + "$ref" : "#/definitions/FlowFileDTO" + } + }, + "xml" : { + "name" : "flowFileEntity" + } + }, + "FlowFileSummaryDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowSnippetDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupDTO" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorDTO" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDTO" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The controller services in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceDTO" + } + } + } + }, + "FunnelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + } + } + }, + "FunnelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "xml" : { + "name" : "funnelEntity" + } + }, + "FunnelsEntity" : { + "type" : "object", + "properties" : { + "funnels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + }, + "xml" : { + "name" : "funnelsEntity" + } + }, + "GarbageCollectionDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the garbage collector." + }, + "collectionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of times garbage collection has run." + }, + "collectionTime" : { + "type" : "string", + "description" : "The total amount of time spent garbage collecting." + }, + "collectionMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of milliseconds spent garbage collecting." + } + } + }, + "HistoryDTO" : { + "type" : "object", + "properties" : { + "total" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of number of actions that matched the search criteria.." + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "actions" : { + "type" : "array", + "description" : "The actions.", + "items" : { + "$ref" : "#/definitions/ActionEntity" + } + } + } + }, + "HistoryEntity" : { + "type" : "object", + "properties" : { + "history" : { + "$ref" : "#/definitions/HistoryDTO" + } + }, + "xml" : { + "name" : "historyEntity" + } + }, + "InputPortsEntity" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "inputPortsEntity" + } + }, + "InstantiateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "templateId" : { + "type" : "string", + "description" : "The identifier of the template." + }, + "encodingVersion" : { + "type" : "string", + "description" : "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." + }, + "snippet" : { + "description" : "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.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "instantiateTemplateRequestEntity" + } + }, + "JaxbLink" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "format" : "uri", + "xml" : { + "attribute" : true + }, + "description" : "The href for the link" + }, + "params" : { + "type" : "object", + "description" : "The params for the link", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "dimensions" : { + "$ref" : "#/definitions/DimensionsDTO" + }, + "component" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "xml" : { + "name" : "labelEntity" + } + }, + "LabelsEntity" : { + "type" : "object", + "properties" : { + "labels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + } + }, + "xml" : { + "name" : "labelsEntity" + } + }, + "LineageDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this lineage query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this lineage query for later retrieval and deletion." + }, + "submissionTime" : { + "type" : "string", + "description" : "When the lineage query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "When the lineage query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percent complete for the lineage query." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the lineage query has finished." + }, + "request" : { + "description" : "The initial lineage result.", + "$ref" : "#/definitions/LineageRequestDTO" + }, + "results" : { + "description" : "The results of the lineage query.", + "$ref" : "#/definitions/LineageResultsDTO" + } + } + }, + "LineageEntity" : { + "type" : "object", + "properties" : { + "lineage" : { + "$ref" : "#/definitions/LineageDTO" + } + }, + "xml" : { + "name" : "lineageEntity" + } + }, + "LineageRequestDTO" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lineageRequestType" : { + "type" : "string", + "description" : "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.", + "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] + }, + "uuid" : { + "type" : "string", + "description" : "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." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this lineage originated if clustered." + } + } + }, + "LineageResultsDTO" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while generating the lineage.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "nodes" : { + "type" : "array", + "description" : "The nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceNodeDTO" + } + }, + "links" : { + "type" : "array", + "description" : "The links between the nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceLinkDTO" + } + } + } + }, + "ListingRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this listing request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this listing request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this listing request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this listing request failed." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of FlowFileSummary objects to return" + }, + "state" : { + "type" : "string", + "description" : "The current state of the listing request." + }, + "queueSize" : { + "description" : "The size of the queue", + "$ref" : "#/definitions/QueueSizeDTO" + }, + "flowFileSummaries" : { + "type" : "array", + "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", + "items" : { + "$ref" : "#/definitions/FlowFileSummaryDTO" + } + }, + "destinationRunning" : { + "type" : "boolean", + "description" : "Whether the destination of the connection is running" + }, + "sourceRunning" : { + "type" : "boolean", + "description" : "Whether the source of the connection is running" + } + } + }, + "ListingRequestEntity" : { + "type" : "object", + "properties" : { + "listingRequest" : { + "$ref" : "#/definitions/ListingRequestDTO" + } + }, + "xml" : { + "name" : "listingRequestEntity" + } + }, + "NodeConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statisticsSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + } + } + }, + "NodeConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + } + } + }, + "NodeCountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The counters from the node.", + "$ref" : "#/definitions/CountersSnapshotDTO" + } + } + }, + "NodeDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node.", + "readOnly" : true + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address.", + "readOnly" : true + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The node's status." + }, + "heartbeat" : { + "type" : "string", + "description" : "the time of the nodes's last heartbeat.", + "readOnly" : true + }, + "connectionRequested" : { + "type" : "string", + "description" : "The time of the node's last connection request.", + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "The roles of this node.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active threads for the NiFi on the node.", + "readOnly" : true + }, + "queued" : { + "type" : "string", + "description" : "The queue the NiFi on the node.", + "readOnly" : true + }, + "events" : { + "type" : "array", + "description" : "The node's events.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/NodeEventDTO" + } + }, + "nodeStartTime" : { + "type" : "string", + "description" : "The time at which this Node was last refreshed.", + "readOnly" : true + } + } + }, + "NodeEntity" : { + "type" : "object", + "properties" : { + "node" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "xml" : { + "name" : "nodeEntity" + } + }, + "NodeEventDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node event." + }, + "category" : { + "type" : "string", + "description" : "The category of the node event." + }, + "message" : { + "type" : "string", + "description" : "The message in the node event." + } + } + }, + "NodePortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The port status snapshot from the node.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + } + } + }, + "NodeProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The process group status snapshot from the node.", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The processor status snapshot from the node.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + } + } + }, + "NodeRemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The remote process group status snapshot from the node.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node that matched the search." + }, + "address" : { + "type" : "string", + "description" : "The address of the node that matched the search." + } + } + }, + "NodeStatusSnapshotsDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node." + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address." + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests." + }, + "statusSnapshots" : { + "type" : "array", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + } + } + }, + "NodeSystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The System Diagnostics snapshot from the node.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + } + } + }, + "OutputPortsEntity" : { + "type" : "object", + "properties" : { + "outputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "outputPortsEntity" + } + }, + "ParameterContextDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The Name of the Parameter Context." + }, + "description" : { + "type" : "string", + "description" : "The Description of the Parameter Context." + }, + "parameters" : { + "type" : "array", + "description" : "The Parameters for the Parameter Context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterEntity" + } + }, + "boundProcessGroups" : { + "type" : "array", + "description" : "The Process Groups that are bound to this Parameter Context", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "id" : { + "type" : "string", + "description" : "The ID the Parameter Context.", + "readOnly" : true + } + } + }, + "ParameterContextEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The Parameter Context", + "$ref" : "#/definitions/ParameterContextDTO" + } + }, + "xml" : { + "name" : "parameterContextEntity" + } + }, + "ParameterContextReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Parameter Context" + }, + "name" : { + "type" : "string", + "description" : "The name of the Parameter Context" + } + } + }, + "ParameterContextReferenceEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "component" : { + "$ref" : "#/definitions/ParameterContextReferenceDTO" + } + }, + "xml" : { + "name" : "parameterContextReferenceEntity" + } + }, + "ParameterContextUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextUpdateStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "$ref" : "#/definitions/ParameterContextDTO" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterContextUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "parameterContextRevision" : { + "description" : "The Revision of the Parameter Context", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" + } + }, + "xml" : { + "name" : "parameterContextUpdateRequestEntity" + } + }, + "ParameterContextUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextValidationRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextValidationStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on.", + "$ref" : "#/definitions/ParameterContextDTO" + }, + "componentValidationResults" : { + "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", + "readOnly" : true, + "$ref" : "#/definitions/ComponentValidationResultsEntity" + } + } + }, + "ParameterContextValidationRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextValidationRequestDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "parameterContextValidationRequestEntity" + } + }, + "ParameterContextValidationStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextsEntity" : { + "type" : "object", + "properties" : { + "parameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system.", + "readOnly" : true + } + }, + "xml" : { + "name" : "parameterContexts" + } + }, + "ParameterDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the Parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the Parameter" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the Parameter" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing this Parameter", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterEntity" : { + "type" : "object", + "properties" : { + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "parameter" : { + "description" : "The parameter information", + "$ref" : "#/definitions/ParameterDTO" + } + }, + "xml" : { + "name" : "parameterEntity" + } + }, + "PeerDTO" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "The hostname of this peer." + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "The port number of this peer." + }, + "secure" : { + "type" : "boolean", + "description" : "Returns if this peer connection is secure." + }, + "flowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flowFiles this peer holds." + } + } + }, + "PeersEntity" : { + "type" : "object", + "properties" : { + "peers" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PeerDTO" + } + } + }, + "xml" : { + "name" : "peersEntity" + } + }, + "Permissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + } + } + }, + "PermissionsDTO" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + } + }, + "PortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the port." + }, + "state" : { + "type" : "string", + "description" : "The state of the port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "transmitting" : { + "type" : "boolean", + "description" : "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." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "userAccessControl" : { + "type" : "array", + "description" : "The users that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "groupAccessControl" : { + "type" : "array", + "description" : "The user groups that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + } + } + }, + "PortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/PortDTO" + }, + "status" : { + "description" : "The status of the port.", + "$ref" : "#/definitions/PortStatusDTO" + }, + "portType" : { + "type" : "string" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + } + }, + "xml" : { + "name" : "portEntity" + } + }, + "PortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "PortStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodePortStatusSnapshotDTO" + } + } + } + }, + "PortStatusEntity" : { + "type" : "object", + "properties" : { + "portStatus" : { + "$ref" : "#/definitions/PortStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "portStatusEntity" + } + }, + "PortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for the port." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been processed in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have been processed in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + } + } + }, + "PortStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "portStatusSnapshot" : { + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "PositionDTO" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "PreviousValueDTO" : { + "type" : "object", + "properties" : { + "previousValue" : { + "type" : "string", + "description" : "The previous value." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the value was modified." + }, + "userIdentity" : { + "type" : "string", + "description" : "The user who changed the previous value." + } + } + }, + "PrioritizerTypesEntity" : { + "type" : "object", + "properties" : { + "prioritizerTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "prioritizerTypesEntity" + } + }, + "ProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the process group." + }, + "variables" : { + "type" : "object", + "description" : "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.", + "readOnly" : true, + "additionalProperties" : { + "type" : "string" + } + }, + "versionControlInformation" : { + "description" : "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", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "parameterContext" : { + "description" : "The Parameter Context that this Process Group is bound to.", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "flowfileConcurrency" : { + "type" : "string", + "description" : "The FlowFile Concurrency for this Process Group.", + "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE" ] + }, + "flowfileOutboundPolicy" : { + "type" : "string", + "description" : "The Oubound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", + "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "contents" : { + "description" : "The contents of this process group.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + } + }, + "ProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessGroupDTO" + }, + "status" : { + "description" : "The status of the process group.", + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "versionedFlowSnapshot" : { + "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupEntity" + } + }, + "ProcessGroupFlowDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "breadcrumb" : { + "description" : "The breadcrumb of the process group.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + }, + "flow" : { + "description" : "The flow structure starting at this Process Group.", + "$ref" : "#/definitions/FlowDTO" + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The time the flow for the process group was last refreshed." + } + } + }, + "ProcessGroupFlowEntity" : { + "type" : "object", + "properties" : { + "permissions" : { + "description" : "The access policy for this process group.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "processGroupFlow" : { + "$ref" : "#/definitions/ProcessGroupFlowDTO" + } + }, + "xml" : { + "name" : "processGroupFlowEntity" + } + }, + "ProcessGroupImportEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The Revision for the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionedFlowSnapshot" : { + "description" : "The Versioned Flow Snapshot to import", + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "xml" : { + "name" : "processGroupImportEntity" + } + }, + "ProcessGroupNameDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" + } + } + }, + "ProcessGroupReplaceRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group being updated" + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this request has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this request failed, or null if this request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + } + } + }, + "ProcessGroupReplaceRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision for the Process Group being updated.", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Process Group Change Request", + "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" + }, + "versionedFlowSnapshot" : { + "description" : "Returns the Versioned Flow to replace with", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "xml" : { + "name" : "processGroupReplaceRequestEntity" + } + }, + "ProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "The aggregate status of all nodes in the cluster", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" + } + } + } + }, + "ProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "processGroupStatus" : { + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupStatusEntity" + } + }, + "ProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "name" : { + "type" : "string", + "description" : "The name of this process group." + }, + "connectionStatusSnapshots" : { + "type" : "array", + "description" : "The status of all connections in the process group.", + "items" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" + } + }, + "processorStatusSnapshots" : { + "type" : "array", + "description" : "The status of all processors in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" + } + }, + "processGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all process groups in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" + } + }, + "remoteProcessGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all remote process groups in the process group.", + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" + } + }, + "inputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all input ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "outputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all output ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are queued up in this ProcessGroup right now" + }, + "queued" : { + "type" : "string", + "description" : "The count/size that is queued in the the process group." + }, + "queuedCount" : { + "type" : "string", + "description" : "The count that is queued for the process group." + }, + "queuedSize" : { + "type" : "string", + "description" : "The size that is queued for the process group." + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The output count/size for the process group in the last 5 minutes." + }, + "flowFilesTransferred" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" + }, + "bytesTransferred" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" + }, + "transferred" : { + "type" : "string", + "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "received" : { + "type" : "string", + "description" : "The count/size sent to the process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "sent" : { + "type" : "string", + "description" : "The count/size sent from this process group in the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for this process group." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the process group." + } + } + }, + "ProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "processGroupStatusSnapshot" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "processGroupsEntity" + } + }, + "ProcessorConfigDTO" : { + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "Descriptors for the processor's properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the processor." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the processor's custom configuration UI if applicable." + }, + "lossTolerant" : { + "type" : "boolean", + "description" : "Whether the processor is loss tolerant." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "defaultConcurrentTasks" : { + "type" : "object", + "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "ProcessorDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the processor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the processor", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "style" : { + "type" : "object", + "description" : "Styles for the processor (background-color : #eee).", + "additionalProperties" : { + "type" : "string" + } + }, + "relationships" : { + "type" : "array", + "description" : "The available relationships that the processor currently supports.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/RelationshipDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the processor." + }, + "supportsParallelProcessing" : { + "type" : "boolean", + "description" : "Whether the processor supports parallel processing." + }, + "supportsEventDriven" : { + "type" : "boolean", + "description" : "Whether the processor supports event driven scheduling." + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether the processor supports batching. This makes the run duration settings available." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the processor persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the processor requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the processor has been deprecated." + }, + "executionNodeRestricted" : { + "type" : "boolean", + "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the processor has multiple versions available." + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "config" : { + "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", + "$ref" : "#/definitions/ProcessorConfigDTO" + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ProcessorEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessorDTO" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "status" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "processorEntity" + } + }, + "ProcessorRunStatusDetailsDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the processor" + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the processor", + "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] + }, + "validationErrors" : { + "type" : "array", + "description" : "The processor's validation errors", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The current number of threads that the processor is currently using" + } + } + }, + "ProcessorRunStatusDetailsEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for the Processor.", + "$ref" : "#/definitions/RevisionDTO" + }, + "permissions" : { + "description" : "The permissions for the Processor.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "runStatusDetails" : { + "description" : "The details of a Processor's run status", + "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Processor.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the Processor" + }, + "type" : { + "type" : "string", + "description" : "The type of the Processor" + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the Processor", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" + } + } + } + }, + "ProcessorStatusEntity" : { + "type" : "object", + "properties" : { + "processorStatus" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processorStatusEntity" + } + }, + "ProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group to which the processor belongs." + }, + "name" : { + "type" : "string", + "description" : "The name of the prcessor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "runStatus" : { + "type" : "string", + "description" : "The state of the processor.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute.", + "enum" : [ "ALL", "PRIMARY" ] + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by this Processor in the last 5 mintues" + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by this Processor in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "taskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of times this Processor has run in the last 5 minutes" + }, + "tasksDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" + }, + "tasks" : { + "type" : "string", + "description" : "The total number of task this connectable has completed over the last 5 minutes." + }, + "tasksDuration" : { + "type" : "string", + "description" : "The total duration of all tasks for this connectable over the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently executing in the processor." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the processor." + } + } + }, + "ProcessorStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "processorStatusSnapshot" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorTypesEntity" : { + "type" : "object", + "properties" : { + "processorTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "processorTypesEntity" + } + }, + "ProcessorsEntity" : { + "type" : "object", + "properties" : { + "processors" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } + }, + "xml" : { + "name" : "processorsEntity" + } + }, + "ProcessorsRunStatusDetailsEntity" : { + "type" : "object", + "properties" : { + "runStatusDetails" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" + } + } + }, + "xml" : { + "name" : "processorsRunStatusDetails" + } + }, + "PropertyDescriptorDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name for the property." + }, + "displayName" : { + "type" : "string", + "description" : "The human readable name for the property." + }, + "description" : { + "type" : "string", + "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value for the property." + }, + "allowableValues" : { + "type" : "array", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "items" : { + "$ref" : "#/definitions/AllowableValueEntity" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether the property is required." + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether the property is sensitive and protected whenever stored or represented." + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether the property is dynamic (user-defined)." + }, + "supportsEl" : { + "type" : "boolean", + "description" : "Whether the property supports expression language." + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "Scope of the Expression Language evaluation for the property." + }, + "identifiesControllerService" : { + "type" : "string", + "description" : "If the property identifies a controller service this returns the fully qualified type." + }, + "identifiesControllerServiceBundle" : { + "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "PropertyDescriptorEntity" : { + "type" : "object", + "properties" : { + "propertyDescriptor" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "xml" : { + "name" : "propertyDescriptor" + } + }, + "PropertyHistoryDTO" : { + "type" : "object", + "properties" : { + "previousValues" : { + "type" : "array", + "description" : "Previous values for a given property.", + "items" : { + "$ref" : "#/definitions/PreviousValueDTO" + } + } + } + }, + "ProvenanceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the provenance query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "The timestamp when the query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "request" : { + "description" : "The provenance request.", + "$ref" : "#/definitions/ProvenanceRequestDTO" + }, + "results" : { + "description" : "The provenance results.", + "$ref" : "#/definitions/ProvenanceResultsDTO" + } + } + }, + "ProvenanceEntity" : { + "type" : "object", + "properties" : { + "provenance" : { + "$ref" : "#/definitions/ProvenanceDTO" + } + }, + "xml" : { + "name" : "provenanceEntity" + } + }, + "ProvenanceEventDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The event uuid." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id. This is a one up number thats unique per node." + }, + "eventTime" : { + "type" : "string", + "description" : "The timestamp of the event." + }, + "eventDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The event duration in milliseconds." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The duration since the lineage began, in milliseconds." + }, + "eventType" : { + "type" : "string", + "description" : "The type of the event." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile for the event." + }, + "fileSize" : { + "type" : "string", + "description" : "The size of the flowfile for the event." + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the flowfile in bytes for the event." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the event originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the event originated." + }, + "groupId" : { + "type" : "string", + "description" : "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." + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component that generated the event." + }, + "componentType" : { + "type" : "string", + "description" : "The type of the component that generated the event." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component that generated the event." + }, + "sourceSystemFlowFileId" : { + "type" : "string", + "description" : "The source system flowfile id." + }, + "alternateIdentifierUri" : { + "type" : "string", + "description" : "The alternate identifier uri for the fileflow for the event." + }, + "attributes" : { + "type" : "array", + "description" : "The attributes of the flowfile for the event.", + "items" : { + "$ref" : "#/definitions/AttributeDTO" + } + }, + "parentUuids" : { + "type" : "array", + "description" : "The parent uuids for the event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The child uuids for the event.", + "items" : { + "type" : "string" + } + }, + "transitUri" : { + "type" : "string", + "description" : "The source/destination system uri if the event was a RECEIVE/SEND." + }, + "relationship" : { + "type" : "string", + "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." + }, + "details" : { + "type" : "string", + "description" : "The event details." + }, + "contentEqual" : { + "type" : "boolean", + "description" : "Whether the input and output content claim is the same." + }, + "inputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the input content is still available." + }, + "inputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the input content claim lives." + }, + "inputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the input content claim lives." + }, + "inputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the input content claim." + }, + "inputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the input content claim where the flowfiles content begins." + }, + "inputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the input content claim formatted." + }, + "inputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the intput content claim in bytes." + }, + "outputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the output content is still available." + }, + "outputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the output content claim lives." + }, + "outputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the output content claim lives." + }, + "outputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the output content claim." + }, + "outputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the output content claim where the flowfiles content begins." + }, + "outputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the output content claim formatted." + }, + "outputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the output content claim in bytes." + }, + "replayAvailable" : { + "type" : "boolean", + "description" : "Whether or not replay is available." + }, + "replayExplanation" : { + "type" : "string", + "description" : "Explanation as to why replay is unavailable." + }, + "sourceConnectionIdentifier" : { + "type" : "string", + "description" : "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." + } + } + }, + "ProvenanceEventEntity" : { + "type" : "object", + "properties" : { + "provenanceEvent" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "xml" : { + "name" : "provenanceEventEntity" + } + }, + "ProvenanceLinkDTO" : { + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "The source node id of the link." + }, + "targetId" : { + "type" : "string", + "description" : "The target node id of the link." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The flowfile uuid that traversed the link." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the link (based on the destination)." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of this link in milliseconds." + } + } + }, + "ProvenanceNodeDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile associated with the provenance event." + }, + "parentUuids" : { + "type" : "array", + "description" : "The uuid of the parent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The uuid of the childrent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "clusterNodeIdentifier" : { + "type" : "string", + "description" : "The identifier of the node that this event/flowfile originated from." + }, + "type" : { + "type" : "string", + "description" : "The type of the node.", + "enum" : [ "FLOWFILE", "EVENT" ] + }, + "eventType" : { + "type" : "string", + "description" : "If the type is EVENT, this is the type of event." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the node in milliseconds." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node formatted." + } + } + }, + "ProvenanceOptionsDTO" : { + "type" : "object", + "properties" : { + "searchableFields" : { + "type" : "array", + "description" : "The available searchable field for the NiFi.", + "items" : { + "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" + } + } + } + }, + "ProvenanceOptionsEntity" : { + "type" : "object", + "properties" : { + "provenanceOptions" : { + "$ref" : "#/definitions/ProvenanceOptionsDTO" + } + }, + "xml" : { + "name" : "provenanceOptionsEntity" + } + }, + "ProvenanceRequestDTO" : { + "type" : "object", + "properties" : { + "searchTerms" : { + "type" : "object", + "description" : "The search terms used to perform the search.", + "additionalProperties" : { + "type" : "string" + } + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node in the cluster where this provenance originated." + }, + "startDate" : { + "type" : "string", + "description" : "The earliest event time to include in the query." + }, + "endDate" : { + "type" : "string", + "description" : "The latest event time to include in the query." + }, + "minimumFileSize" : { + "type" : "string", + "description" : "The minimum file size to include in the query." + }, + "maximumFileSize" : { + "type" : "string", + "description" : "The maximum file size to include in the query." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of results to include." + }, + "summarize" : { + "type" : "boolean", + "description" : "Whether or not to summarize provenance events returned. This property is false by default." + }, + "incrementalResults" : { + "type" : "boolean", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." + } + } + }, + "ProvenanceResultsDTO" : { + "type" : "object", + "properties" : { + "provenanceEvents" : { + "type" : "array", + "description" : "The provenance events that matched the search criteria.", + "items" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "total" : { + "type" : "string", + "description" : "The total number of results formatted." + }, + "totalCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of results." + }, + "generated" : { + "type" : "string", + "description" : "Then the search was performed." + }, + "oldestEvent" : { + "type" : "string", + "description" : "The oldest event available in the provenance repository." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the server that's used for event time." + }, + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while performing the provenance request.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ProvenanceSearchableFieldDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the searchable field." + }, + "field" : { + "type" : "string", + "description" : "The searchable field." + }, + "label" : { + "type" : "string", + "description" : "The label for the searchable field." + }, + "type" : { + "type" : "string", + "description" : "The type of the searchable field." + } + } + }, + "QueueSizeDTO" : { + "type" : "object", + "properties" : { + "byteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of objects in a queue." + }, + "objectCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The count of objects in a queue." + } + } + }, + "RegistryClientEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RegistryDTO" + } + }, + "xml" : { + "name" : "registryClientEntity" + } + }, + "RegistryClientsEntity" : { + "type" : "object", + "properties" : { + "registries" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RegistryClientEntity" + } + } + }, + "xml" : { + "name" : "registryClientsEntity" + } + }, + "RegistryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The registry identifier" + }, + "name" : { + "type" : "string", + "description" : "The registry name" + }, + "description" : { + "type" : "string", + "description" : "The registry description" + }, + "uri" : { + "type" : "string", + "description" : "The registry URI" + } + } + }, + "RelationshipDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The relationship name." + }, + "description" : { + "type" : "string", + "description" : "The relationship description." + }, + "autoTerminate" : { + "type" : "boolean", + "description" : "Whether or not flowfiles sent to this relationship should auto terminate." + } + } + }, + "RemotePortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the RemotePort.", + "enum" : [ "TRANSMITTING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupContentsDTO" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "description" : "The input ports to which data can be sent.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports from which data can be retrieved.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + } + } + }, + "RemoteProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "targetUri" : { + "type" : "string", + "description" : "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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "targetSecure" : { + "type" : "boolean", + "description" : "Whether the target is running securely." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the remote process group." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string" + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "authorizationIssues" : { + "type" : "array", + "description" : "Any remote authorization issues for the remote process group.", + "items" : { + "type" : "string" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote process group is actively transmitting." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "activeRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote input ports." + }, + "inactiveRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote input ports." + }, + "activeRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote output ports." + }, + "inactiveRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote output ports." + }, + "flowRefreshed" : { + "type" : "string", + "description" : "The timestamp when this remote process group was last refreshed." + }, + "contents" : { + "description" : "The contents of the remote process group. Will contain available input/output ports.", + "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" + } + } + }, + "RemoteProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + }, + "status" : { + "description" : "The status of the remote process group.", + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupEntity" + } + }, + "RemoteProcessGroupPortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "targetId" : { + "type" : "string", + "description" : "The id of the target port." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the target port." + }, + "comments" : { + "type" : "string", + "description" : "The comments as configured on the target port." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote port is configured for transmission." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "exists" : { + "type" : "boolean", + "description" : "Whether the target port exists." + }, + "targetRunning" : { + "type" : "boolean", + "description" : "Whether the target port is running." + }, + "connected" : { + "type" : "boolean", + "description" : "Whether the port has either an incoming or outgoing connection." + }, + "batchSettings" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSettingsDTO" + } + } + }, + "RemoteProcessGroupPortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "remoteProcessGroupPort" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupPortEntity" + } + }, + "RemoteProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" + } + } + } + }, + "RemoteProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroupStatus" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "remoteProcessGroupStatusEntity" + } + }, + "RemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group the remote process group resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the remote process group." + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." + }, + "sent" : { + "type" : "string", + "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." + }, + "received" : { + "type" : "string", + "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." + } + } + }, + "RemoteProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "remoteProcessGroupStatusSnapshot" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "remoteProcessGroupsEntity" + } + }, + "ReportingTaskDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the reporting task." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the reporting task." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the reporting task.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "comments" : { + "type" : "string", + "description" : "The comments of the reporting task." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the reporting task persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the reporting task requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the reporting task has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the reporting task has multiple versions available." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "The default scheduling period for the different scheduling strategies.", + "additionalProperties" : { + "type" : "string" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the reporting task.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the reporting tasks properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the reporting task." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." + }, + "validationErrors" : { + "type" : "array", + "description" : "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.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the reporting task." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ReportingTaskEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ReportingTaskDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ReportingTask.", + "readOnly" : true, + "$ref" : "#/definitions/ReportingTaskStatusDTO" + } + }, + "xml" : { + "name" : "reportingTaskEntity" + } + }, + "ReportingTaskRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ReportingTask.", + "enum" : [ "RUNNING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ReportingTaskStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ReportingTask", + "readOnly" : true, + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "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)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ReportingTaskTypesEntity" : { + "type" : "object", + "properties" : { + "reportingTaskTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "reportingTaskTypesEntity" + } + }, + "ReportingTasksEntity" : { + "type" : "object", + "properties" : { + "reportingTasks" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } + }, + "xml" : { + "name" : "reportingTasksEntity" + } + }, + "RequiredPermissionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The required sub-permission necessary for this restriction." + }, + "label" : { + "type" : "string", + "description" : "The label for the required sub-permission necessary for this restriction." + } + } + }, + "ResourceDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource." + }, + "name" : { + "type" : "string", + "description" : "The name of the resource." + } + } + }, + "ResourcesEntity" : { + "type" : "object", + "properties" : { + "resources" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ResourceDTO" + } + } + }, + "xml" : { + "name" : "resourcesEntity" + } + }, + "RevisionDTO" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "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" + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the flow.", + "readOnly" : true + } + } + }, + "RevisionInfo" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "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." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "NiFi Registry 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." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the entity.", + "readOnly" : true + } + }, + "description" : "The revision information for an entity managed through the REST API." + }, + "RunStatusDetailsRequestEntity" : { + "type" : "object", + "properties" : { + "processorIds" : { + "type" : "array", + "description" : "The IDs of all processors whose run status details should be provided", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + }, + "xml" : { + "name" : "runStatusDetailsRequest" + } + }, + "ScheduleComponentsEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "scheduleComponentEntity" + } + }, + "SearchResultGroupDTO" : { + "type" : "object", + "required" : [ "id" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The name of the group." + } + } + }, + "SearchResultsDTO" : { + "type" : "object", + "properties" : { + "processorResults" : { + "type" : "array", + "description" : "The processors that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "connectionResults" : { + "type" : "array", + "description" : "The connections that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "processGroupResults" : { + "type" : "array", + "description" : "The process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "inputPortResults" : { + "type" : "array", + "description" : "The input ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "outputPortResults" : { + "type" : "array", + "description" : "The output ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "remoteProcessGroupResults" : { + "type" : "array", + "description" : "The remote process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "funnelResults" : { + "type" : "array", + "description" : "The funnels that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "labelResults" : { + "type" : "array", + "description" : "The labels that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "controllerServiceNodeResults" : { + "type" : "array", + "description" : "The controller service nodes that matched the search", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterContextResults" : { + "type" : "array", + "description" : "The parameter contexts that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterResults" : { + "type" : "array", + "description" : "The parameters that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + } + } + }, + "SearchResultsEntity" : { + "type" : "object", + "properties" : { + "searchResultsDTO" : { + "$ref" : "#/definitions/SearchResultsDTO" + } + }, + "xml" : { + "name" : "searchResultsEntity" + } + }, + "SnippetDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the snippet." + }, + "uri" : { + "type" : "string", + "description" : "The URI of the snippet." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The group id for the components in the snippet." + }, + "processGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "remoteProcessGroups" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "processors" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "inputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "outputPorts" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "connections" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "labels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "funnels" : { + "type" : "object", + "description" : "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).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + } + } + }, + "SnippetEntity" : { + "type" : "object", + "properties" : { + "snippet" : { + "description" : "The snippet.", + "$ref" : "#/definitions/SnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "snippetEntity" + } + }, + "StartVersionControlRequestEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "startVersionControlRequestEntity" + } + }, + "StateEntryDTO" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string", + "description" : "The key for this state." + }, + "value" : { + "type" : "string", + "description" : "The value for this state." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the state originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the state originated." + } + } + }, + "StateMapDTO" : { + "type" : "object", + "properties" : { + "scope" : { + "type" : "string", + "description" : "The scope of this StateMap." + }, + "totalEntryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." + }, + "state" : { + "type" : "array", + "description" : "The state.", + "items" : { + "$ref" : "#/definitions/StateEntryDTO" + } + } + } + }, + "StatusDescriptorDTO" : { + "type" : "object", + "properties" : { + "field" : { + "type" : "string", + "description" : "The name of the status field." + }, + "label" : { + "type" : "string", + "description" : "The label for the status field." + }, + "description" : { + "type" : "string", + "description" : "The description of the status field." + }, + "formatter" : { + "type" : "string", + "description" : "The formatter for the status descriptor." + } + } + }, + "StatusHistoryDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When the status history was generated." + }, + "componentDetails" : { + "type" : "object", + "description" : "A Map of key/value pairs that describe the component that the status history belongs to", + "additionalProperties" : { + "type" : "string" + } + }, + "fieldDescriptors" : { + "type" : "array", + "description" : "The Descriptors that provide information on each of the metrics provided in the status history", + "items" : { + "$ref" : "#/definitions/StatusDescriptorDTO" + } + }, + "aggregateSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeStatusSnapshotsDTO" + } + } + } + }, + "StatusHistoryEntity" : { + "type" : "object", + "properties" : { + "statusHistory" : { + "$ref" : "#/definitions/StatusHistoryDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "statusHistoryEntity" + } + }, + "StatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of the snapshot." + }, + "statusMetrics" : { + "type" : "object", + "description" : "The status metrics.", + "additionalProperties" : { + "type" : "integer", + "format" : "int64" + } + } + } + }, + "StorageUsageDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." + }, + "freeSpace" : { + "type" : "string", + "description" : "Amount of free space." + }, + "totalSpace" : { + "type" : "string", + "description" : "Amount of total space." + }, + "usedSpace" : { + "type" : "string", + "description" : "Amount of used space." + }, + "freeSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of free space." + }, + "totalSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of total space." + }, + "usedSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of used space." + }, + "utilization" : { + "type" : "string", + "description" : "Utilization of this storage location." + } + } + }, + "StreamingOutput" : { + "type" : "object" + }, + "SubmitReplayRequestEntity" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event identifier" + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier of the node where to submit the replay request." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "SystemDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "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.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "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.", + "items" : { + "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" + } + } + } + }, + "SystemDiagnosticsEntity" : { + "type" : "object", + "properties" : { + "systemDiagnostics" : { + "$ref" : "#/definitions/SystemDiagnosticsDTO" + } + }, + "xml" : { + "name" : "systemDiagnosticsEntity" + } + }, + "SystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "totalNonHeap" : { + "type" : "string", + "description" : "Total size of non heap." + }, + "totalNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes allocated to the JVM not used for heap" + }, + "usedNonHeap" : { + "type" : "string", + "description" : "Amount of use non heap." + }, + "usedNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes used by the JVM not in the heap space" + }, + "freeNonHeap" : { + "type" : "string", + "description" : "Amount of free non heap." + }, + "freeNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of free non-heap bytes available to the JVM" + }, + "maxNonHeap" : { + "type" : "string", + "description" : "Maximum size of non heap." + }, + "maxNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" + }, + "nonHeapUtilization" : { + "type" : "string", + "description" : "Utilization of non heap." + }, + "totalHeap" : { + "type" : "string", + "description" : "Total size of heap." + }, + "totalHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of bytes that are available for the JVM heap to use" + }, + "usedHeap" : { + "type" : "string", + "description" : "Amount of used heap." + }, + "usedHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of JVM heap that are currently being used" + }, + "freeHeap" : { + "type" : "string", + "description" : "Amount of free heap." + }, + "freeHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" + }, + "maxHeap" : { + "type" : "string", + "description" : "Maximum size of heap." + }, + "maxHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that can be used by the JVM" + }, + "heapUtilization" : { + "type" : "string", + "description" : "Utilization of heap." + }, + "availableProcessors" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of available processors if supported by the underlying system." + }, + "processorLoadAverage" : { + "type" : "number", + "format" : "double", + "description" : "The processor load average if supported by the underlying system." + }, + "totalThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of threads." + }, + "daemonThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of daemon threads." + }, + "uptime" : { + "type" : "string", + "description" : "The uptime of the Java virtual machine" + }, + "flowFileRepositoryStorageUsage" : { + "description" : "The flowfile repository storage usage.", + "$ref" : "#/definitions/StorageUsageDTO" + }, + "contentRepositoryStorageUsage" : { + "type" : "array", + "description" : "The content repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "provenanceRepositoryStorageUsage" : { + "type" : "array", + "description" : "The provenance repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "garbageCollection" : { + "type" : "array", + "description" : "The garbage collection details.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/GarbageCollectionDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "When the diagnostics were generated." + }, + "versionInfo" : { + "description" : "The nifi, os, java, and build version information", + "$ref" : "#/definitions/VersionInfoDTO" + } + } + }, + "TemplateDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI for the template." + }, + "id" : { + "type" : "string", + "description" : "The id of the template." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the Process Group that the template belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when this template was created." + }, + "encodingVersion" : { + "type" : "string", + "xml" : { + "name" : "encoding-version", + "attribute" : true + }, + "description" : "The encoding version of this template." + }, + "snippet" : { + "description" : "The contents of the template.", + "$ref" : "#/definitions/FlowSnippetDTO" + } + }, + "xml" : { + "name" : "template" + } + }, + "TemplateEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "template" : { + "$ref" : "#/definitions/TemplateDTO" + } + }, + "xml" : { + "name" : "templateEntity" + } + }, + "TemplatesEntity" : { + "type" : "object", + "properties" : { + "templates" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + } + }, + "xml" : { + "name" : "templatesEntity" + } + }, + "TenantDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + } + } + }, + "TenantEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/TenantDTO" + } + }, + "xml" : { + "name" : "tenantEntity" + } + }, + "TenantsEntity" : { + "type" : "object", + "properties" : { + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + }, + "xml" : { + "name" : "tenantsEntity" + } + }, + "TransactionResultEntity" : { + "type" : "object", + "properties" : { + "flowFileSent" : { + "type" : "integer", + "format" : "int32" + }, + "responseCode" : { + "type" : "integer", + "format" : "int32" + }, + "message" : { + "type" : "string" + } + }, + "xml" : { + "name" : "transactionResultEntity" + } + }, + "UpdateControllerServiceReferenceRequestEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The identifier of the Controller Service." + }, + "state" : { + "type" : "string", + "description" : "The new state of the references for the controller service.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] + }, + "referencingComponentRevisions" : { + "type" : "object", + "description" : "The revisions for all referencing components.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "updateControllerServiceReferenceRequestEntity" + } + }, + "UserDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies this user belongs to.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummaryEntity" + } + } + } + }, + "UserEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserDTO" + } + }, + "xml" : { + "name" : "userEntity" + } + }, + "UserGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "users" : { + "type" : "array", + "description" : "The users that belong to the user group.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "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.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } + } + }, + "UserGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserGroupDTO" + } + }, + "xml" : { + "name" : "userGroupEntity" + } + }, + "UserGroupsEntity" : { + "type" : "object", + "properties" : { + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } + }, + "xml" : { + "name" : "userGroupsEntity" + } + }, + "UsersEntity" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserEntity" + } + } + }, + "xml" : { + "name" : "usersEntity" + } + }, + "VariableDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the variable" + }, + "value" : { + "type" : "string", + "description" : "The value of the variable" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group where this Variable is defined", + "readOnly" : true + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableEntity" : { + "type" : "object", + "properties" : { + "variable" : { + "description" : "The variable information", + "$ref" : "#/definitions/VariableDTO" + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "variableEntity" + } + }, + "VariableRegistryDTO" : { + "type" : "object", + "properties" : { + "variables" : { + "type" : "array", + "description" : "The variables that are available in this Variable Registry", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VariableEntity" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this Variable Registry belongs to" + } + } + }, + "VariableRegistryEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision of the Process Group that the Variable Registry belongs to", + "$ref" : "#/definitions/RevisionDTO" + }, + "variableRegistry" : { + "description" : "The Variable Registry.", + "$ref" : "#/definitions/VariableRegistryDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "variableRegistryEntity" + } + }, + "VariableRegistryUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableRegistryUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Variable Registry Update Request", + "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "variableRegistryUpdateRequestEntity" + } + }, + "VariableRegistryUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "VersionControlComponentMappingEntity" : { + "type" : "object", + "properties" : { + "versionControlComponentMapping" : { + "type" : "object", + "description" : "The mapping of Versioned Component Identifiers to instance ID's", + "additionalProperties" : { + "type" : "string" + } + }, + "processGroupRevision" : { + "description" : "The revision of the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlComponentMappingEntity" + } + }, + "VersionControlInformationDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that is under version control" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is stored in" + }, + "registryName" : { + "type" : "string", + "description" : "The name of the registry that the flow is stored in", + "readOnly" : true + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket that the flow is stored in" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket that the flow is stored in", + "readOnly" : true + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "flowDescription" : { + "type" : "string", + "description" : "The description of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "state" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "stateExplanation" : { + "type" : "string", + "description" : "Explanation of why the group is in the specified state", + "readOnly" : true + } + } + }, + "VersionControlInformationEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The Revision for the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlInformationEntity" + } + }, + "VersionInfoDTO" : { + "type" : "object", + "properties" : { + "niFiVersion" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "javaVendor" : { + "type" : "string", + "description" : "Java JVM vendor" + }, + "javaVersion" : { + "type" : "string", + "description" : "Java version" + }, + "osName" : { + "type" : "string", + "description" : "Host operating system name" + }, + "osVersion" : { + "type" : "string", + "description" : "Host operating system version" + }, + "osArchitecture" : { + "type" : "string", + "description" : "Host operating system architecture" + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Build timestamp" + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "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." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/Bundle" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "readOnly" : true, + "minimum" : 0 + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDTO" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is tracked to" + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket where the flow is stored" + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "description" : { + "type" : "string", + "description" : "A description of the flow" + }, + "comments" : { + "type" : "string", + "description" : "Comments for the changeset" + }, + "action" : { + "type" : "string", + "description" : "The action being performed", + "enum" : [ "COMMIT", "FORCE_COMMIT" ] + } + } + }, + "VersionedFlowEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + } + }, + "xml" : { + "name" : "versionedFlowEntity" + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "required" : [ "flowContents", "snapshotMetadata" ], + "properties" : { + "snapshotMetadata" : { + "description" : "The metadata for this snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "flowContents" : { + "description" : "The contents of the versioned flow", + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterContexts" : { + "type" : "object", + "description" : "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.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "flow" : { + "description" : "The flow this snapshot is for", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlow" + }, + "bucket" : { + "description" : "The bucket where the flow is located", + "readOnly" : true, + "$ref" : "#/definitions/Bucket" + }, + "latest" : { + "type" : "boolean" + } + } + }, + "VersionedFlowSnapshotEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshot" : { + "description" : "The versioned flow snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshot" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + }, + "updateDescendantVersionedFlows" : { + "type" : "boolean", + "description" : "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." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionedFlowSnapshotEntity" + } + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to." + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "readOnly" : true + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + } + } + }, + "VersionedFlowSnapshotMetadataEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadata" : { + "description" : "The collection of versioned flow snapshot metadata", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataEntity" + } + }, + "VersionedFlowSnapshotMetadataSetEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadataSet" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataSetEntity" + } + }, + "VersionedFlowUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group being updated" + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this request has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this request failed, or null if this request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + }, + "versionControlInformation" : { + "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", + "readOnly" : true, + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "VersionedFlowUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision for the Process Group being updated.", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Flow Update Request", + "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" + } + }, + "xml" : { + "name" : "versionedFlowUpdateRequestEntity" + } + }, + "VersionedFlowsEntity" : { + "type" : "object", + "properties" : { + "versionedFlows" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowsEntity" + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the context" + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "flowFileConcurrency" : { + "type" : "string", + "description" : "The configured FlowFile Concurrency for the Process Group" + }, + "flowFileOutboundPolicy" : { + "type" : "string", + "description" : "The FlowFile Outbound Policy for the Process Group" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "The type of Processor" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + } + } +} diff --git a/resources/client_gen/api_defs/registry-0.7.0.json b/resources/client_gen/api_defs/registry-0.7.0.json new file mode 100644 index 00000000..274e1094 --- /dev/null +++ b/resources/client_gen/api_defs/registry-0.7.0.json @@ -0,0 +1,6485 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", + "version" : "0.7.0", + "title" : "Apache NiFi Registry REST API", + "termsOfService" : "As described in the license", + "contact" : { + "name" : "Apache NiFi Registry", + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0 License", + "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-registry-api", + "tags" : [ { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "bucket bundles", + "description" : "Create extension bundles scoped to an existing bucket in the registry. " + }, { + "name" : "bucket flows", + "description" : "Create flows scoped to an existing bucket in the registry." + }, { + "name" : "buckets", + "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." + }, { + "name" : "bundles", + "description" : "Gets metadata about extension bundles and their versions. " + }, { + "name" : "config", + "description" : "Retrieves the configuration for this NiFi Registry." + }, { + "name" : "extension repository", + "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " + }, { + "name" : "extensions", + "description" : "Find and retrieve extensions. " + }, { + "name" : "flows", + "description" : "Gets metadata about flows." + }, { + "name" : "items", + "description" : "Retrieve items across all buckets for which the user is authorized." + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Get access status", + "description" : "Returns the current client's authenticated identity and permissions to top-level resources", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUser" + } + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/access/logout" : { + "delete" : { + "tags" : [ "access" ], + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "logOut", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token trying all providers", + "description" : "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 '.", + "operationId" : "createAccessTokenByTryingAllProviders", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using identity provider", + "description" : "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 '.", + "operationId" : "createAccessTokenUsingIdentityProviderCredentials", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider/test" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Test identity provider", + "description" : "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'.", + "operationId" : "testIdentityProviderRecognizesCredentialsFormat", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "The format of the credentials were not recognized by the currently configured identity provider." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider/usage" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Get identity provider usage", + "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", + "operationId" : "getIdentityProviderUsageInstructions", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using kerberos", + "description" : "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 '.", + "operationId" : "createAccessTokenUsingKerberosTicket", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/login" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using basic auth", + "description" : "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 ', where is the base64 encoded value of ':'. 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 '.", + "operationId" : "createAccessTokenUsingBasicAuthCredentials", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + }, + "security" : [ { + "BasicAuth" : [ ] + } ] + } + }, + "/buckets" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get all buckets", + "description" : "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.", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Bucket" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + }, + "post" : { + "tags" : [ "buckets" ], + "summary" : "Create bucket", + "description" : "", + "operationId" : "createBucket", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The bucket to create", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Bucket" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets", + "action" : "write" + } + } + }, + "/buckets/fields" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get bucket fields", + "description" : "Retrieves bucket field names for searching or sorting on buckets.", + "operationId" : "getAvailableBucketFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/buckets/{bucketId}" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get bucket", + "description" : "Gets the bucket with the given id.", + "operationId" : "getBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "put" : { + "tags" : [ "buckets" ], + "summary" : "Update bucket", + "description" : "Updates the bucket with the given id.", + "operationId" : "updateBucket", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated bucket", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Bucket" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "buckets" ], + "summary" : "Delete bucket", + "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", + "operationId" : "deleteBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "delete" + } + } + }, + "/buckets/{bucketId}/bundles" : { + "get" : { + "tags" : [ "bucket bundles" ], + "summary" : "Get extension bundles by bucket", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionBundles", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionBundle" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/bundles/{bundleType}" : { + "post" : { + "tags" : [ "bucket bundles" ], + "summary" : "Create extension bundle version", + "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createExtensionBundleVersion", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "bundleType", + "in" : "path", + "description" : "The type of the bundle", + "required" : true, + "type" : "string", + "enum" : [ "nifi-nar", "minifi-cpp" ] + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flows", + "description" : "Retrieves all flows in the given bucket.", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlow" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "post" : { + "tags" : [ "bucket flows" ], + "summary" : "Create flow", + "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", + "operationId" : "createFlow", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The details of the flow to create.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow", + "description" : "Retrieves the flow with the given id in the given bucket.", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "put" : { + "tags" : [ "bucket flows" ], + "summary" : "Update bucket flow", + "description" : "Updates the flow with the given id in the given bucket.", + "operationId" : "updateFlow", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated flow", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "bucket flows" ], + "summary" : "Delete bucket flow", + "description" : "Deletes a flow, including all saved versions of that flow.", + "operationId" : "deleteFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "delete" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow diff", + "description" : "Computes the differences between two given versions of a flow.", + "operationId" : "getFlowDiff", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionA", + "in" : "path", + "description" : "The first version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + }, { + "name" : "versionB", + "in" : "path", + "description" : "The second version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowDifference" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow versions", + "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", + "operationId" : "getFlowVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "post" : { + "tags" : [ "bucket flows" ], + "summary" : "Create flow version", + "description" : "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.", + "operationId" : "createFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The new versioned flow snapshot.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get latest bucket flow version content", + "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", + "operationId" : "getLatestFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get latest bucket flow version metadata", + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "getLatestFlowVersionMetadata", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow version", + "description" : "Gets the given version of a flow, including the metadata and content for the version.", + "operationId" : "getFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionNumber", + "in" : "path", + "description" : "The version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get all bundles", + "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results 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. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundles", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "query", + "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", + "required" : false, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionBundle" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/bundles/versions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get all bundle versions", + "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "query", + "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", + "required" : false, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", + "required" : false, + "type" : "string" + }, { + "name" : "version", + "in" : "query", + "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BundleVersionMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/bundles/{bundleId}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle", + "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetExtensionBundle", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionBundle" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "delete" : { + "tags" : [ "bundles" ], + "summary" : "Delete bundle", + "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalDeleteExtensionBundle", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionBundle" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/bundles/{bundleId}/versions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle versions", + "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BundleVersionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version", + "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "delete" : { + "tags" : [ "bundles" ], + "summary" : "Delete bundle version", + "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalDeleteBundleVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/bundles/{bundleId}/versions/{version}/content" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version content", + "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionContent", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extensions", + "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension", + "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionExtension", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Extension" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension docs", + "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersionExtensionDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension docs details", + "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/config" : { + "get" : { + "tags" : [ "config" ], + "summary" : "Get configration", + "description" : "Gets the NiFi Registry configurations.", + "operationId" : "getConfiguration", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryConfiguration" + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies,/tenants", + "action" : "read" + } + } + }, + "/extension-repository" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo buckets", + "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoBucket" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extension-repository/{bucketName}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo groups", + "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoGroup" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo artifacts", + "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoArtifacts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group id", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoArtifact" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo versions", + "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoVersionSummary" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version", + "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionRepoVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version content", + "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionContent", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extensions", + "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension", + "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtension", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Extension" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension docs", + "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensionDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension details", + "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version checksum", + "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionSha256", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get global extension repo version checksum", + "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getGlobalExtensionRepoVersionSha256", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get all extensions", + "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleType", + "in" : "query", + "description" : "The type of bundles to return", + "required" : false, + "type" : "string", + "enum" : [ "nifi-nar", "minifi-cpp" ] + }, { + "name" : "extensionType", + "in" : "query", + "description" : "The type of extensions to return", + "required" : false, + "type" : "string", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, { + "name" : "tag", + "in" : "query", + "description" : "The tags to filter on, will be used in an OR statement", + "required" : false, + "type" : "array", + "items" : { + "type" : "string" + }, + "collectionFormat" : "multi" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionMetadataContainer" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions/provided-service-api" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get extensions providing service API", + "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionsProvidingServiceAPI", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "className", + "in" : "query", + "description" : "The name of the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "The groupId of the bundle containing the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "The artifactId of the bundle containing the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "query", + "description" : "The version of the bundle containing the service API class", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionMetadataContainer" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions/tags" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get extension tags", + "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getTags", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TagCount" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/flows/fields" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow fields", + "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", + "operationId" : "getAvailableFlowFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/flows/{flowId}" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow", + "description" : "Gets a flow by id.", + "operationId" : "globalGetFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow versions", + "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", + "operationId" : "globalGetFlowVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/latest" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get latest flow version", + "description" : "Gets the latest version of a flow, including metadata and flow content.", + "operationId" : "globalGetLatestFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get latest flow version metadata", + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "globalGetLatestFlowVersionMetadata", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow version", + "description" : "Gets the given version of a flow, including metadata and flow content.", + "operationId" : "globalGetFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionNumber", + "in" : "path", + "description" : "The version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/items" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get all items", + "description" : "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.", + "operationId" : "getItems", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BucketItem" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/items/fields" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get item fields", + "description" : "Retrieves the item field names for searching or sorting on bucket items.", + "operationId" : "getAvailableBucketItemFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/items/{bucketId}" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get bucket items", + "description" : "Gets the items located in the given bucket.", + "operationId" : "getItemsInBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BucketItem" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/policies" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get all access policies", + "description" : "", + "operationId" : "getAccessPolicies", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/AccessPolicy" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + }, + "post" : { + "tags" : [ "policies" ], + "summary" : "Create access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "write" + } + } + }, + "/policies/resources" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get available resources", + "description" : "Gets the available resources that support access/authorization policies", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Resource" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get access policy for resource", + "description" : "Gets an access policy for the specified action and resource", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write", "delete" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Update access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Delete access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "delete" + } + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user groups", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroup" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Create user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Update user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Delete user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "delete" + } + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get all users", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/User" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Create user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/User" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Update user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/User" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Delete user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "delete" + } + } + } + }, + "securityDefinitions" : { + "Authorization" : { + "description" : "NiFi Registry Auth Token (JWT)", + "type" : "apiKey", + "name" : "Authorization", + "in" : "header" + }, + "BasicAuth" : { + "description" : "HTTP Basic Auth", + "type" : "basic" + } + }, + "definitions" : { + "AccessPolicy" : { + "type" : "object", + "required" : [ "action", "resource" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The id of the policy. Set by server at creation time.", + "readOnly" : true + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write", "delete" ] + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", + "readOnly" : true + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "AccessPolicySummary" : { + "type" : "object", + "required" : [ "action", "resource" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The id of the policy. Set by server at creation time.", + "readOnly" : true + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write", "delete" ] + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", + "readOnly" : true + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "AllowableValue" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string", + "description" : "The value of the allowable value" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the allowable value" + }, + "description" : { + "type" : "string", + "description" : "The description of the allowable value" + } + } + }, + "Attribute" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the attribute" + }, + "description" : { + "type" : "string", + "description" : "The description of the attribute" + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "Bucket" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket." + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "readOnly" : true, + "minimum" : 1 + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "allowBundleRedeploy" : { + "type" : "boolean", + "description" : "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." + }, + "allowPublicRead" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" + }, + "permissions" : { + "description" : "The access that the current user has to this bucket.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "BucketItem" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "BuildInfo" : { + "type" : "object", + "properties" : { + "buildTool" : { + "type" : "string", + "description" : "The tool used to build the version of the bundle" + }, + "buildFlags" : { + "type" : "string", + "description" : "The flags used to build the version of the bundle" + }, + "buildBranch" : { + "type" : "string", + "description" : "The branch used to build the version of the bundle" + }, + "buildTag" : { + "type" : "string", + "description" : "The tag used to build the version of the bundle" + }, + "buildRevision" : { + "type" : "string", + "description" : "The revision used to build the version of the bundle" + }, + "built" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp the version of the bundle was built" + }, + "builtBy" : { + "type" : "string", + "description" : "The identity of the user that performed the build" + } + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleInfo" : { + "type" : "object", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket where the bundle is located" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket where the bundle is located" + }, + "bundleId" : { + "type" : "string", + "description" : "The id of the bundle" + }, + "bundleType" : { + "type" : "string", + "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the bundle" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API the bundle was built against" + } + } + }, + "BundleVersion" : { + "type" : "object", + "required" : [ "versionMetadata" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "versionMetadata" : { + "description" : "The metadata about this version of the extension bundle", + "$ref" : "#/definitions/BundleVersionMetadata" + }, + "dependencies" : { + "type" : "array", + "description" : "The set of other bundle versions that this version is dependent on", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BundleVersionDependency" + } + }, + "bundle" : { + "description" : "The bundle this version is for", + "readOnly" : true, + "$ref" : "#/definitions/ExtensionBundle" + }, + "bucket" : { + "description" : "The bucket that the extension bundle belongs to", + "$ref" : "#/definitions/Bucket" + }, + "filename" : { + "type" : "string" + } + } + }, + "BundleVersionDependency" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The group id of the bundle dependency" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle dependency" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle dependency" + } + } + }, + "BundleVersionMetadata" : { + "type" : "object", + "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "id" : { + "type" : "string", + "description" : "The id of this version of the extension bundle" + }, + "bundleId" : { + "type" : "string", + "description" : "The id of the extension bundle this version is for" + }, + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket the extension bundle belongs to" + }, + "version" : { + "type" : "string", + "description" : "The version of the extension bundle" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the create date of this version", + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The identity that created this version" + }, + "description" : { + "type" : "string", + "description" : "The description for this version" + }, + "sha256" : { + "type" : "string", + "description" : "The hex representation of the SHA-256 digest of the binary content for this version" + }, + "sha256Supplied" : { + "type" : "boolean", + "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" + }, + "contentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the binary content for this version in bytes", + "minimum" : 0 + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API that this bundle version was built against" + }, + "buildInfo" : { + "description" : "The build information about this version", + "$ref" : "#/definitions/BuildInfo" + } + } + }, + "ComponentDifference" : { + "type" : "object", + "properties" : { + "valueA" : { + "type" : "string", + "description" : "The earlier value from the difference." + }, + "valueB" : { + "type" : "string", + "description" : "The newer value from the difference." + }, + "changeDescription" : { + "type" : "string", + "description" : "The description of the change." + }, + "differenceType" : { + "type" : "string", + "description" : "The key to the difference." + }, + "differenceTypeDescription" : { + "type" : "string", + "description" : "The description of the change type." + } + } + }, + "ComponentDifferenceGroup" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The id of the component whose changes are grouped together." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component whose changes are grouped together." + }, + "componentType" : { + "type" : "string", + "description" : "The type of component these changes relate to." + }, + "processGroupId" : { + "type" : "string", + "description" : "The process group id for this component." + }, + "differences" : { + "type" : "array", + "description" : "The list of changes related to this component between the 2 versions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifference" + } + } + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceDefinition" : { + "type" : "object", + "properties" : { + "className" : { + "type" : "string", + "description" : "The class name of the service API" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API" + } + } + }, + "CurrentUser" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The identity of the current user", + "readOnly" : true + }, + "anonymous" : { + "type" : "boolean", + "description" : "Indicates if the current user is anonymous", + "readOnly" : true + }, + "loginSupported" : { + "type" : "boolean", + "description" : "Indicates if the NiFi instance supports logging in" + }, + "resourcePermissions" : { + "description" : "The access that the current user has to top level resources", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + } + } + }, + "DeprecationNotice" : { + "type" : "object", + "properties" : { + "reason" : { + "type" : "string", + "description" : "The reason for the deprecation" + }, + "alternatives" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The alternatives to use", + "items" : { + "type" : "string", + "xml" : { + "name" : "alternative" + } + } + } + } + }, + "DynamicProperty" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic property name" + }, + "value" : { + "type" : "string", + "description" : "The description of the dynamic property value" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic property" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of the expression language support", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + } + } + }, + "DynamicRelationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic relationship name" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic relationship" + } + } + }, + "Extension" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "deprecationNotice" : { + "description" : "The deprecation notice of the extension", + "$ref" : "#/definitions/DeprecationNotice" + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "tags" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The tags of the extension", + "items" : { + "type" : "string", + "xml" : { + "name" : "tag" + } + } + }, + "properties" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The properties of the extension", + "items" : { + "xml" : { + "name" : "property" + }, + "$ref" : "#/definitions/Property" + } + }, + "dynamicProperties" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The dynamic properties of the extension", + "items" : { + "xml" : { + "name" : "dynamicProperty" + }, + "$ref" : "#/definitions/DynamicProperty" + } + }, + "relationships" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The relationships of the extension", + "items" : { + "xml" : { + "name" : "relationship" + }, + "$ref" : "#/definitions/Relationship" + } + }, + "dynamicRelationship" : { + "description" : "The dynamic relationships of the extension", + "$ref" : "#/definitions/DynamicRelationship" + }, + "readsAttributes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The attributes read from flow files by the extension", + "items" : { + "xml" : { + "name" : "readsAttribute" + }, + "$ref" : "#/definitions/Attribute" + } + }, + "writesAttributes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The attributes written to flow files by the extension", + "items" : { + "xml" : { + "name" : "writesAttribute" + }, + "$ref" : "#/definitions/Attribute" + } + }, + "stateful" : { + "description" : "The information about how the extension stores state", + "$ref" : "#/definitions/Stateful" + }, + "restricted" : { + "description" : "The restrictions of the extension", + "$ref" : "#/definitions/Restricted" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement of the extension", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "systemResourceConsiderations" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The resource considerations of the extension", + "items" : { + "xml" : { + "name" : "systemResourceConsideration" + }, + "$ref" : "#/definitions/SystemResourceConsideration" + } + }, + "seeAlso" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The names of other extensions to see", + "items" : { + "type" : "string", + "xml" : { + "name" : "see" + } + } + }, + "providedServiceAPIs" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The service APIs provided by this extension", + "items" : { + "xml" : { + "name" : "providedServiceAPI" + }, + "$ref" : "#/definitions/ProvidedServiceAPI" + } + } + } + }, + "ExtensionBundle" : { + "type" : "object", + "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "bundleType" : { + "type" : "string", + "description" : "The type of the extension bundle", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the extension bundle" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the extension bundle" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this extension bundle.", + "readOnly" : true, + "minimum" : 0 + } + } + }, + "ExtensionFilterParams" : { + "type" : "object", + "properties" : { + "bundleType" : { + "type" : "string", + "description" : "The type of bundle", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "extensionType" : { + "type" : "string", + "description" : "The type of extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "tags" : { + "type" : "array", + "description" : "The tags", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ExtensionMetadata" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the extension" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "deprecationNotice" : { + "description" : "The deprecation notice of the extension", + "$ref" : "#/definitions/DeprecationNotice" + }, + "tags" : { + "type" : "array", + "description" : "The tags of the extension", + "items" : { + "type" : "string" + } + }, + "restricted" : { + "description" : "The restrictions of the extension", + "$ref" : "#/definitions/Restricted" + }, + "providedServiceAPIs" : { + "type" : "array", + "description" : "The service APIs provided by the extension", + "items" : { + "$ref" : "#/definitions/ProvidedServiceAPI" + } + }, + "bundleInfo" : { + "description" : "The information for the bundle where this extension is located", + "$ref" : "#/definitions/BundleInfo" + }, + "hasAdditionalDetails" : { + "type" : "boolean", + "description" : "Whether or not the extension has additional detail documentation" + }, + "linkDocs" : { + "description" : "A WebLink to the documentation for this extension.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + } + } + }, + "ExtensionMetadataContainer" : { + "type" : "object", + "properties" : { + "numResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extensions in the response" + }, + "filterParams" : { + "description" : "The filter parameters submitted for the request", + "$ref" : "#/definitions/ExtensionFilterParams" + }, + "extensions" : { + "type" : "array", + "description" : "The metadata for the extensions", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + } + }, + "ExtensionRepoArtifact" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + } + } + }, + "ExtensionRepoBucket" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket" + } + } + }, + "ExtensionRepoGroup" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + } + } + }, + "ExtensionRepoVersion" : { + "type" : "object", + "properties" : { + "extensionsLink" : { + "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "downloadLink" : { + "description" : "The WebLink to download this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "sha256Link" : { + "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "sha256Supplied" : { + "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + } + } + }, + "ExtensionRepoVersionSummary" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + }, + "version" : { + "type" : "string", + "description" : "The version" + }, + "author" : { + "type" : "string", + "description" : "The identity of the user that created this version" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when this version was created" + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "Fields" : { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "JaxbLink" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "format" : "uri", + "xml" : { + "attribute" : true + }, + "description" : "The href for the link" + }, + "params" : { + "type" : "object", + "description" : "The params for the link", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "Permissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + } + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "Property" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name" + }, + "description" : { + "type" : "string", + "description" : "The description" + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value" + }, + "controllerServiceDefinition" : { + "description" : "The controller service required by this property, or null if none is required", + "$ref" : "#/definitions/ControllerServiceDefinition" + }, + "allowableValues" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The allowable values for this property", + "items" : { + "xml" : { + "name" : "allowableValue" + }, + "$ref" : "#/definitions/AllowableValue" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is sensitive" + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of expression language support", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + }, + "dynamicallyModifiesClasspath" : { + "type" : "boolean", + "description" : "Whether or not the processor dynamically modifies the classpath" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the processor is dynamic" + } + } + }, + "ProvidedServiceAPI" : { + "type" : "object", + "properties" : { + "className" : { + "type" : "string", + "description" : "The class name of the service API being provided" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API being provided" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API being provided" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API being provided" + } + } + }, + "RegistryConfiguration" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports configurable users and groups.", + "readOnly" : true + } + } + }, + "Relationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the relationship" + }, + "description" : { + "type" : "string", + "description" : "The description of the relationship" + }, + "autoTerminated" : { + "type" : "boolean", + "description" : "Whether or not the relationship is auto-terminated by default" + } + } + }, + "Resource" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the resource.", + "readOnly" : true + } + } + }, + "ResourcePermissions" : { + "type" : "object", + "properties" : { + "buckets" : { + "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "tenants" : { + "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "policies" : { + "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "proxy" : { + "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "anyTopLevelResource" : { + "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "Restricted" : { + "type" : "object", + "properties" : { + "generalRestrictionExplanation" : { + "type" : "string", + "description" : "The general restriction for the extension, or null if only specific restrictions exist" + }, + "restrictions" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The specific restrictions", + "items" : { + "xml" : { + "name" : "restriction" + }, + "$ref" : "#/definitions/Restriction" + } + } + } + }, + "Restriction" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "type" : "string", + "description" : "The permission required for this restriction" + }, + "explanation" : { + "type" : "string", + "description" : "The explanation of this restriction" + } + } + }, + "RevisionInfo" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "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." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "NiFi Registry 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." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the entity.", + "readOnly" : true + } + }, + "description" : "The revision information for an entity managed through the REST API." + }, + "Stateful" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description for how the extension stores state" + }, + "scopes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The scopes used to store state", + "items" : { + "type" : "string", + "xml" : { + "name" : "scope" + }, + "enum" : [ "CLUSTER", "LOCAL" ] + } + } + } + }, + "SystemResourceConsideration" : { + "type" : "object", + "properties" : { + "resource" : { + "type" : "string", + "description" : "The resource to consider" + }, + "description" : { + "type" : "string", + "description" : "The description of how the resource is affected" + } + } + }, + "TagCount" : { + "type" : "object", + "properties" : { + "tag" : { + "type" : "string", + "description" : "The tag label" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of occurrences of the given tag" + } + } + }, + "Tenant" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "User" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "UserGroup" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + }, + "users" : { + "type" : "array", + "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "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." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "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." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "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." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "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." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/Bundle" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "readOnly" : true, + "minimum" : 0 + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDifference" : { + "type" : "object", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket that the flow is stored in." + }, + "flowId" : { + "type" : "string", + "description" : "The id of the flow that is being examined." + }, + "versionA" : { + "type" : "integer", + "format" : "int32", + "description" : "The earlier version from the diff operation." + }, + "versionB" : { + "type" : "integer", + "format" : "int32", + "description" : "The latter version from the diff operation." + }, + "componentDifferenceGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceGroup" + } + } + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "required" : [ "flowContents", "snapshotMetadata" ], + "properties" : { + "snapshotMetadata" : { + "description" : "The metadata for this snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "flowContents" : { + "description" : "The contents of the versioned flow", + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterContexts" : { + "type" : "object", + "description" : "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.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "flow" : { + "description" : "The flow this snapshot is for", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlow" + }, + "bucket" : { + "description" : "The bucket where the flow is located", + "readOnly" : true, + "$ref" : "#/definitions/Bucket" + }, + "latest" : { + "type" : "boolean" + } + } + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to." + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "readOnly" : true + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + } + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the context" + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "flowFileOutboundPolicy" : { + "type" : "string", + "description" : "The FlowFile Outbound Policy for the Process Group" + }, + "flowFileConcurrency" : { + "type" : "string", + "description" : "The configured FlowFile Concurrency for the Process Group" + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "The type of Processor" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the processor.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "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." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "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.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[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." + }, + "targetUris" : { + "type" : "string", + "description" : "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." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "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." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + } + } +} diff --git a/resources/client_gen/generate_api_client.sh b/resources/client_gen/generate_api_client.sh index 7e5f2996..50657875 100755 --- a/resources/client_gen/generate_api_client.sh +++ b/resources/client_gen/generate_api_client.sh @@ -8,7 +8,7 @@ # Params echo Exporting Params -export wv_client_name=${wv_client_name:-nifi} +export wv_client_name=${wv_client_name:-registry} export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-2.3.1.jar} export wv_tmp_dir=${wv_tmp_dir:-${HOME}/Projects/tmp} diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index ffd443ee..1350776f 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -2,13 +2,13 @@ version: '2' # the latest tag is not pulling the latest image on Travis, so setting explicit services: nifi: - image: apache/nifi:1.11.4 + image: apache/nifi:1.12.1 container_name: nifi hostname: nifi ports: - "8080:8080" registry: - image: apache/nifi-registry:0.5.0 + image: apache/nifi-registry:0.7.0 container_name: registry hostname: registry ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index f6bcc941..ac944f5f 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.1' services: secure-nifi: - image: apache/nifi:1.11.4 + image: apache/nifi:1.12.1 container_name: secure-nifi hostname: secure-nifi ports: @@ -25,7 +25,7 @@ services: - LDAP_IDENTITY_STRATEGY=USE_USERNAME - LDAP_URL=ldap://ldap.forumsys.com:389 secure-registry: - image: apache/nifi-registry:0.5.0 + image: apache/nifi-registry:0.7.0 container_name: secure-registry hostname: secure-registry ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index 89650ae3..2c60fc41 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -25,7 +25,7 @@ services: ports: - "10192:8080" nifi: - image: apache/nifi:1.11.4 + image: apache/nifi:1.12.1 container_name: nifi hostname: nifi ports: @@ -47,7 +47,7 @@ services: environment: - NIFI_REGISTRY_WEB_HTTP_PORT=18030 registry: - image: apache/nifi-registry:0.5.0 + image: apache/nifi-registry:0.7.0 container_name: registry hostname: registry ports: diff --git a/setup.cfg b/setup.cfg index d07329a5..661231d2 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.14.3 +current_version = 0.15.0 commit = True tag = True @@ -19,4 +19,3 @@ exclude = docs [aliases] test = pytest - diff --git a/setup.py b/setup.py index 309ebd90..2adb8ec9 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ with open('docs/history.rst') as history_file: history = history_file.read() -proj_version = '0.14.3' +proj_version = '0.15.0' with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() From d94a82192e94d2f1fb8e16e3582b639713a930f4 Mon Sep 17 00:00:00 2001 From: "pyup.io bot" Date: Wed, 11 Nov 2020 15:37:43 +0200 Subject: [PATCH 38/40] Update ruamel.yaml from 0.16.10 to 0.16.12 (#219) --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 2c27a10f..6d1795e6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -15,7 +15,7 @@ requests[security]>=2.18 # urllib3, cryptography are handled by requests # Import Export and Utils implementation -ruamel.yaml==0.16.10 +ruamel.yaml==0.16.12 # Demo deployment automation docker>=2.5.1 From 8e770c58c53590953b3cfa38896973e28369b075 Mon Sep 17 00:00:00 2001 From: Otto Fowler Date: Thu, 12 Nov 2020 09:07:51 -0500 Subject: [PATCH 39/40] check-version should ignore snapshot (#232) --- nipyapi/utils.py | 21 ++++++++++++++++++--- tests/test_utils.py | 4 ++++ 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 95991c2c..a1ce08cb 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -8,6 +8,7 @@ from __future__ import absolute_import, unicode_literals import logging import json +import re import time from copy import copy from functools import reduce @@ -436,11 +437,26 @@ def start_docker_containers(docker_containers, network_name='demo'): )) +def strip_snapshot(java_version): + """ + Strips the -SNAPSHOT suffix from a version string + + Args: + java_version (str): the version string + """ + assert isinstance(java_version, six.string_types) + return re.sub("-SNAPSHOT", "", java_version) + + def check_version(base, comparator=None, service='nifi'): """ Compares version 'a' against either version 'b', 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 + Args: base (str): The base version for the comparison test comparator (optional[str]): The version to compare against @@ -457,12 +473,11 @@ def check_version(base, comparator=None, service='nifi'): ver_a = version.parse(base) if comparator: # if b is set, we compare the passed versions + comparator = strip_snapshot(comparator) ver_b = version.parse(comparator) else: # if b not set, we compare a against the connected nifi instance - ver_b = version.parse( - nipyapi.system.get_nifi_version_info().ni_fi_version - ) + ver_b = version.parse(strip_snapshot(nipyapi.system.get_nifi_version_info().ni_fi_version)) if ver_b > ver_a: return -1 if ver_b < ver_a: diff --git a/tests/test_utils.py b/tests/test_utils.py index 0eebe0a0..5834e5e7 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -135,6 +135,10 @@ def test_check_version(regress_nifi): assert utils.check_version('1.2.3', '0.2.3') == 1 # Check RC assert utils.check_version('1.0.0-rc1', '1.0.0') == -1 + # Check that snapshots are disregarded + assert utils.check_version('1.11.0', '1.13.0-SNAPSHOT') == -1 + assert utils.check_version('1.11.0', "1.11.0-SNAPSHOT") == 0 + assert utils.check_version('1.11.0', "1.10.0-SNAPSHOT") == 1 # Check current version assert utils.check_version( system.get_nifi_version_info().ni_fi_version From e13e1f35cdc313d139d687ee7feb30cf9af6490b Mon Sep 17 00:00:00 2001 From: Otto Fowler Date: Thu, 3 Dec 2020 09:40:36 -0500 Subject: [PATCH 40/40] add public api for deserializing models (#236) * update dump so that it supports dumping swagger entities this pr also fixes a bug where the nifi style of xml was resulting in incomplete objects * update to sync with next branch --- nipyapi/nifi/api_client.py | 32 +- nipyapi/utils.py | 14 +- .../swagger_templates/api_client.mustache | 34 +- tests/conftest.py | 6 +- tests/resources/nipyapi_testTemplate_01.xml | 2612 +++++++++-------- tests/test_canvas.py | 10 +- tests/test_templates.py | 27 +- 7 files changed, 1427 insertions(+), 1308 deletions(-) diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index 0755c822..4e6dc0a3 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -194,6 +194,9 @@ def sanitize_for_serialization(self, obj): elif isinstance(obj, list): return [self.sanitize_for_serialization(sub_obj) for sub_obj in obj] + elif isinstance(obj, set): + return {self.sanitize_for_serialization(sub_obj) + for sub_obj in obj} elif isinstance(obj, tuple): return tuple(self.sanitize_for_serialization(sub_obj) for sub_obj in obj) @@ -253,6 +256,9 @@ def __deserialize(self, data, klass): if type(klass) == str: if klass.startswith('list['): sub_kls = re.match('list\[(.*)\]', klass).group(1) + if isinstance(data, dict): + # ok, we got a single instance when we may have gotten a list + return self.__deserialize(data, sub_kls) return [self.__deserialize(sub_data, sub_kls) for sub_data in data] @@ -609,6 +615,16 @@ def __deserialize_datatime(self, string): ) ) + def deserialize_model(self, data, klass): + """ + Deserializes list or dict to model. + + :param data: dict, list. + :param klass: class literal. + :return: model object. + """ + return self.__deserialize_model(data, klass) + def __deserialize_model(self, data, klass): """ Deserializes list or dict to model. @@ -626,7 +642,21 @@ def __deserialize_model(self, data, klass): and klass.attribute_map[attr] in data \ and isinstance(data, (list, dict)): value = data[klass.attribute_map[attr]] - kwargs[attr] = self.__deserialize(value, attr_type) + if attr_type.startswith('list['): + # if this is a list, we may get back a single item + # or a list + # create the list object if it doesn't exist + # append the return + if not kwargs.get(attr): + kwargs[attr] = [] + deserialized_value = self.__deserialize(value, attr_type) + if deserialized_value: + if isinstance(deserialized_value, list): + kwargs[attr].extend(deserialized_value) + else: + kwargs[attr].append(deserialized_value) + else: + kwargs[attr] = self.__deserialize(value, attr_type) instance = klass(**kwargs) diff --git a/nipyapi/utils.py b/nipyapi/utils.py index a1ce08cb..fe2d60f1 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -33,19 +33,27 @@ def dump(obj, mode='json'): """ - Dumps a native datatype object to json or yaml, defaults to json + Dumps a native datatype object or swagger entity to json or yaml, defaults to json Args: - obj (varies): The native datatype object to serialise + 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 """ assert mode in ['json', 'yaml'] + unset = False + if nipyapi.config.nifi_config.api_client is None: + unset = True + nipyapi.config.nifi_config.api_client = nipyapi.nifi.ApiClient() + + prepared_obj = nipyapi.config.nifi_config.api_client.sanitize_for_serialization(obj) + if unset: + nipyapi.config.nifi_config.api_client = None try: out = json.dumps( - obj=obj, + obj=prepared_obj, sort_keys=True, indent=4 # default=_json_default diff --git a/resources/client_gen/swagger_templates/api_client.mustache b/resources/client_gen/swagger_templates/api_client.mustache index 382080e9..e09e33fb 100644 --- a/resources/client_gen/swagger_templates/api_client.mustache +++ b/resources/client_gen/swagger_templates/api_client.mustache @@ -185,6 +185,9 @@ class ApiClient(object): elif isinstance(obj, list): return [self.sanitize_for_serialization(sub_obj) for sub_obj in obj] + elif isinstance(obj, set): + return {self.sanitize_for_serialization(sub_obj) + for sub_obj in obj} elif isinstance(obj, tuple): return tuple(self.sanitize_for_serialization(sub_obj) for sub_obj in obj) @@ -244,6 +247,9 @@ class ApiClient(object): if type(klass) == str: if klass.startswith('list['): sub_kls = re.match('list\[(.*)\]', klass).group(1) + if isinstance(data, dict): + # ok, we got a single instance when we may have gotten a list + return self.__deserialize(data, sub_kls) return [self.__deserialize(sub_data, sub_kls) for sub_data in data] @@ -600,6 +606,16 @@ class ApiClient(object): ) ) + def deserialize_model(self, data, klass): + """ + Deserializes list or dict to model. + + :param data: dict, list. + :param klass: class literal. + :return: model object. + """ + return self.__deserialize_model(data, klass) + def __deserialize_model(self, data, klass): """ Deserializes list or dict to model. @@ -617,8 +633,22 @@ class ApiClient(object): and klass.attribute_map[attr] in data \ and isinstance(data, (list, dict)): value = data[klass.attribute_map[attr]] - kwargs[attr] = self.__deserialize(value, attr_type) + if attr_type.startswith('list['): + # if this is a list, we may get back a single item + # or a list + # create the list object if it doesn't exist + # append the return + if not kwargs.get(attr): + kwargs[attr] = [] + deserialized_value = self.__deserialize(value, attr_type) + if deserialized_value: + if isinstance(deserialized_value, list): + kwargs[attr].extend(deserialized_value) + else: + kwargs[attr].append(deserialized_value) + else: + kwargs[attr] = self.__deserialize(value, attr_type) - instance = klass(**kwargs) + instance = klass(**kwargs) return instance diff --git a/tests/conftest.py b/tests/conftest.py index 326f9ba9..14d0e9b3 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -51,7 +51,7 @@ # Can't use skiptest with parametrize for Travis # Mostly because loading up all the environments takes too long -default_nifi_endpoints = ['http://localhost:8080/nifi-api'] +default_nifi_endpoints = ['http://' + test_host + ':8080/nifi-api'] regress_nifi_endpoints = [ 'http://' + test_host + ':10112/nifi-api', 'http://' + test_host + ':10120/nifi-api', @@ -60,9 +60,9 @@ ] secure_nifi_endpoints = ['https://' + test_host + ':8443/nifi-api'] default_registry_endpoints = [ - ('http://localhost:18080/nifi-registry-api', + ('http://' + test_host + ':18080/nifi-registry-api', 'http://registry:18080', - 'http://localhost:8080/nifi-api' + 'http://' + test_host + ':8080/nifi-api' ) ] regress_registry_endpoints = [ diff --git a/tests/resources/nipyapi_testTemplate_01.xml b/tests/resources/nipyapi_testTemplate_01.xml index 712b7ba0..6b044cb1 100644 --- a/tests/resources/nipyapi_testTemplate_01.xml +++ b/tests/resources/nipyapi_testTemplate_01.xml @@ -61,18 +61,18 @@ 1 GB 10000 -a5137dc1-f9fd-3d5a-0000-000000000000 -a083c6ca-7f4f-3493-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + a083c6ca-7f4f-3493-0000-000000000000 + PROCESSOR 0 sec 1 success -a5137dc1-f9fd-3d5a-0000-000000000000 -2d3df4f9-2edc-30e5-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 2d3df4f9-2edc-30e5-0000-000000000000 + PROCESSOR 0 @@ -82,17 +82,17 @@ 1 GB 10000 -a5137dc1-f9fd-3d5a-0000-000000000000 -926e07f0-2f76-3995-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 926e07f0-2f76-3995-0000-000000000000 + PROCESSOR 0 sec 1 -a5137dc1-f9fd-3d5a-0000-000000000000 -56bc5f8b-c556-3fda-0000-000000000000 -INPUT_PORT + a5137dc1-f9fd-3d5a-0000-000000000000 + 56bc5f8b-c556-3fda-0000-000000000000 + INPUT_PORT 0 @@ -102,18 +102,18 @@ 1 GB 10000 -a5137dc1-f9fd-3d5a-0000-000000000000 -5b3f4152-5615-3a7d-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 5b3f4152-5615-3a7d-0000-000000000000 + PROCESSOR 0 sec 1 success -a5137dc1-f9fd-3d5a-0000-000000000000 -c810adb5-12ad-3b88-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + c810adb5-12ad-3b88-0000-000000000000 + PROCESSOR 0 @@ -123,18 +123,18 @@ 1 GB 10000 -a5137dc1-f9fd-3d5a-0000-000000000000 -9001f21d-c558-3d7e-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 9001f21d-c558-3d7e-0000-000000000000 + PROCESSOR 0 sec 1 success -a5137dc1-f9fd-3d5a-0000-000000000000 -ace958df-c4b3-37f0-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + ace958df-c4b3-37f0-0000-000000000000 + PROCESSOR 0 @@ -144,22 +144,22 @@ 1 GB 10000 --74.86676788330078 -403.3262634277344 + -74.86676788330078 + 403.3262634277344 -a5137dc1-f9fd-3d5a-0000-000000000000 -22b9459d-15bb-32bc-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 22b9459d-15bb-32bc-0000-000000000000 + PROCESSOR 0 sec 1 fork events -a5137dc1-f9fd-3d5a-0000-000000000000 -926e07f0-2f76-3995-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 926e07f0-2f76-3995-0000-000000000000 + PROCESSOR 0 @@ -169,18 +169,18 @@ 1 GB 10000 -a5137dc1-f9fd-3d5a-0000-000000000000 -2d3df4f9-2edc-30e5-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 2d3df4f9-2edc-30e5-0000-000000000000 + PROCESSOR 0 sec 1 fork events -a5137dc1-f9fd-3d5a-0000-000000000000 -926e07f0-2f76-3995-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 926e07f0-2f76-3995-0000-000000000000 + PROCESSOR 0 @@ -190,18 +190,18 @@ 1 GB 10000 -a5137dc1-f9fd-3d5a-0000-000000000000 -ace958df-c4b3-37f0-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + ace958df-c4b3-37f0-0000-000000000000 + PROCESSOR 0 sec 1 fork events -a5137dc1-f9fd-3d5a-0000-000000000000 -926e07f0-2f76-3995-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 926e07f0-2f76-3995-0000-000000000000 + PROCESSOR 0 @@ -211,22 +211,22 @@ 1 GB 10000 -754.2969970703125 -324.2012939453125 + 754.2969970703125 + 324.2012939453125 -a5137dc1-f9fd-3d5a-0000-000000000000 -c810adb5-12ad-3b88-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + c810adb5-12ad-3b88-0000-000000000000 + PROCESSOR 0 sec 1 fork events -a5137dc1-f9fd-3d5a-0000-000000000000 -926e07f0-2f76-3995-0000-000000000000 -PROCESSOR + a5137dc1-f9fd-3d5a-0000-000000000000 + 926e07f0-2f76-3995-0000-000000000000 + PROCESSOR 0 @@ -234,84 +234,86 @@ 969358f5-ab70-35ea-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -nifi-record-serialization-services-nar -org.apache.nifi -1.5.0 + nifi-record-serialization-services-nar + org.apache.nifi + 1.5.0 - - schema-access-strategy - - schema-access-strategy - - - - schema-registry - - org.apache.nifi.schemaregistry.services.SchemaRegistry - schema-registry - - - - schema-name - - schema-name - - - - schema-text - - schema-text - - - - Date Format - - Date Format - - - - Time Format - - Time Format - - - - Timestamp Format - - Timestamp Format - - + + schema-access-strategy + + schema-access-strategy + + + + schema-registry + + + org.apache.nifi.schemaregistry.services.SchemaRegistry + + schema-registry + + + + schema-name + + schema-name + + + + schema-text + + schema-text + + + + Date Format + + Date Format + + + + Time Format + + Time Format + + + + Timestamp Format + + Timestamp Format + + Read Prov JSON false - - schema-access-strategy - schema-name - - - schema-registry - ee4d2c3e-c488-3b95-0000-000000000000 - - - schema-name - provenanceEvent - - - schema-text - ${avro.schema} - - - Date Format - - - Time Format - - - Timestamp Format - + + schema-access-strategy + schema-name + + + schema-registry + ee4d2c3e-c488-3b95-0000-000000000000 + + + schema-name + provenanceEvent + + + schema-text + ${avro.schema} + + + Date Format + + + Time Format + + + Timestamp Format + DISABLED org.apache.nifi.json.JsonTreeReader @@ -320,211 +322,213 @@ b4c65be0-0248-35ad-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -nifi-record-serialization-services-nar -org.apache.nifi -1.5.0 + nifi-record-serialization-services-nar + org.apache.nifi + 1.5.0 - - Schema Write Strategy - - Schema Write Strategy - - - - schema-access-strategy - - schema-access-strategy - - - - schema-registry - - org.apache.nifi.schemaregistry.services.SchemaRegistry - schema-registry - - - - schema-name - - schema-name - - - - schema-text - - schema-text - - - - Date Format - - Date Format - - - - Time Format - - Time Format - - - - Timestamp Format - - Timestamp Format - - - - CSV Format - - CSV Format - - - - Value Separator - - Value Separator - - - - Include Header Line - - Include Header Line - - - - Quote Character - - Quote Character - - - - Escape Character - - Escape Character - - - - Comment Marker - - Comment Marker - - - - Null String - - Null String - - - - Trim Fields - - Trim Fields - - - - Quote Mode - - Quote Mode - - - - Record Separator - - Record Separator - - - - Include Trailing Delimiter - - Include Trailing Delimiter - - - - csvutils-character-set - - csvutils-character-set - - + + Schema Write Strategy + + Schema Write Strategy + + + + schema-access-strategy + + schema-access-strategy + + + + schema-registry + + + org.apache.nifi.schemaregistry.services.SchemaRegistry + + schema-registry + + + + schema-name + + schema-name + + + + schema-text + + schema-text + + + + Date Format + + Date Format + + + + Time Format + + Time Format + + + + Timestamp Format + + Timestamp Format + + + + CSV Format + + CSV Format + + + + Value Separator + + Value Separator + + + + Include Header Line + + Include Header Line + + + + Quote Character + + Quote Character + + + + Escape Character + + Escape Character + + + + Comment Marker + + Comment Marker + + + + Null String + + Null String + + + + Trim Fields + + Trim Fields + + + + Quote Mode + + Quote Mode + + + + Record Separator + + Record Separator + + + + Include Trailing Delimiter + + Include Trailing Delimiter + + + + csvutils-character-set + + csvutils-character-set + + Write Prov CSV false - - Schema Write Strategy - schema-name - - - schema-access-strategy - schema-name - - - schema-registry - ee4d2c3e-c488-3b95-0000-000000000000 - - - schema-name - provenanceEvent - - - schema-text - ${avro.schema} - - - Date Format - - - Time Format - - - Timestamp Format - - - CSV Format - custom - - - Value Separator - , - - - Include Header Line - true - - - Quote Character - " - - - Escape Character - \ - - - Comment Marker - - - Null String - - - Trim Fields - true - - - Quote Mode - MINIMAL - - - Record Separator - \n - - - Include Trailing Delimiter - false - - - csvutils-character-set - + + Schema Write Strategy + schema-name + + + schema-access-strategy + schema-name + + + schema-registry + ee4d2c3e-c488-3b95-0000-000000000000 + + + schema-name + provenanceEvent + + + schema-text + ${avro.schema} + + + Date Format + + + Time Format + + + Timestamp Format + + + CSV Format + custom + + + Value Separator + , + + + Include Header Line + true + + + Quote Character + " + + + Escape Character + \ + + + Comment Marker + + + Null String + + + Trim Fields + true + + + Quote Mode + MINIMAL + + + Record Separator + \n + + + Include Trailing Delimiter + false + + + csvutils-character-set + DISABLED org.apache.nifi.csv.CSVRecordSetWriter @@ -533,118 +537,121 @@ bc75027b-870b-3b94-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -nifi-scripting-nar -org.apache.nifi -1.5.0 + nifi-scripting-nar + org.apache.nifi + 1.5.0 - - Script Engine - - Script Engine - - - - Script File - - Script File - - - - Script Body - - Script Body - - - - Module Directory - - Module Directory - - + + Script Engine + + Script Engine + + + + Script File + + Script File + + + + Script Body + + Script Body + + + + Module Directory + + Module Directory + + Write Prov XML false - - Script Engine - Groovy - - - Script File - - - Script Body - import groovy.xml.MarkupBuilder -import org.apache.nifi.controller.AbstractControllerService -import org.apache.nifi.flowfile.FlowFile -import org.apache.nifi.logging.ComponentLog -import org.apache.nifi.schema.access.SchemaNotFoundException -import org.apache.nifi.serialization.RecordSetWriter -import org.apache.nifi.serialization.RecordSetWriterFactory -import org.apache.nifi.serialization.WriteResult -import org.apache.nifi.serialization.record.Record -import org.apache.nifi.serialization.record.RecordSet -import org.apache.nifi.stream.io.NonCloseableOutputStream + + Script Engine + Groovy + + + Script File + + + Script Body + import groovy.xml.MarkupBuilder + import org.apache.nifi.controller.AbstractControllerService + import org.apache.nifi.flowfile.FlowFile + import org.apache.nifi.logging.ComponentLog + import org.apache.nifi.schema.access.SchemaNotFoundException + import org.apache.nifi.serialization.RecordSetWriter + import org.apache.nifi.serialization.RecordSetWriterFactory + import org.apache.nifi.serialization.WriteResult + import org.apache.nifi.serialization.record.Record + import org.apache.nifi.serialization.record.RecordSet + import org.apache.nifi.stream.io.NonCloseableOutputStream -class GroovyRecordSetWriter implements RecordSetWriter { + class GroovyRecordSetWriter implements RecordSetWriter { - @Override - WriteResult write(Record r, OutputStream out) throws IOException { - new OutputStreamWriter(new NonCloseableOutputStream(out)).with {osw -> - new MarkupBuilder(osw).record { - r.schema.fieldNames.each {fieldName -> - "$fieldName" r.getValue(fieldName) - } - } - } - WriteResult.of(0, [:]) - } + @Override + WriteResult write(Record r, OutputStream out) throws IOException { + new OutputStreamWriter(new NonCloseableOutputStream(out)).with {osw -> + new MarkupBuilder(osw).record { + r.schema.fieldNames.each {fieldName -> + "$fieldName" r.getValue(fieldName) + } + } + } + WriteResult.of(0, [:]) + } - @Override - String getMimeType() { - return 'application/xml' - } + @Override + String getMimeType() { + return 'application/xml' + } - @Override - WriteResult write(final RecordSet rs, final OutputStream rawOut) throws IOException { - int count = 0 + @Override + WriteResult write(final RecordSet rs, final OutputStream rawOut) throws + IOException { + int count = 0 - new OutputStreamWriter(new NonCloseableOutputStream(rawOut)).with {osw -> - new MarkupBuilder(osw).recordSet { + new OutputStreamWriter(new NonCloseableOutputStream(rawOut)).with {osw -> + new MarkupBuilder(osw).recordSet { - Record r - while (r = rs.next()) { - count++ + Record r + while (r = rs.next()) { + count++ - record { - rs.schema.fieldNames.each {fieldName -> - "$fieldName" r.getValue(fieldName) - } - } - } - } - } - WriteResult.of(count, [:]) - } -} + record { + rs.schema.fieldNames.each {fieldName -> + "$fieldName" r.getValue(fieldName) + } + } + } + } + } + WriteResult.of(count, [:]) + } + } -class GroovyRecordSetWriterFactory extends AbstractControllerService implements RecordSetWriterFactory { + class GroovyRecordSetWriterFactory extends AbstractControllerService implements + RecordSetWriterFactory { - @Override - RecordSetWriter createWriter(ComponentLog logger, FlowFile flowFile, InputStream flowFileContent) throws SchemaNotFoundException, IOException { - return new GroovyRecordSetWriter() - } -} + @Override + RecordSetWriter createWriter(ComponentLog logger, FlowFile flowFile, InputStream + flowFileContent) throws SchemaNotFoundException, IOException { + return new GroovyRecordSetWriter() + } + } -writer = new GroovyRecordSetWriterFactory() - - - - Module Directory - + writer = new GroovyRecordSetWriterFactory() + + + + Module Directory + DISABLED org.apache.nifi.record.script.ScriptedRecordSetWriter @@ -653,182 +660,183 @@ writer = new GroovyRecordSetWriterFactory() ee4d2c3e-c488-3b95-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -nifi-registry-nar -org.apache.nifi -1.5.0 + nifi-registry-nar + org.apache.nifi + 1.5.0 - - avro-reg-validated-field-names - - avro-reg-validated-field-names - - - - provenanceEvent - - provenanceEvent - - + + avro-reg-validated-field-names + + avro-reg-validated-field-names + + + + provenanceEvent + + provenanceEvent + + Internal Avro Schema Registry false - - avro-reg-validated-field-names - - - provenanceEvent - { - "namespace": "nifi", - "name": "provenanceEvent", - "type": "record", - "fields": [ - { - "name": "eventId", - "type": "string" - }, - { - "name": "eventOrdinal", - "type": "long" - }, - { - "name": "eventType", - "type": "string" - }, - { - "name": "timestampMillis", - "type": { - "type": "long", - "logicalType": "timestamp-millis" - } - }, - { - "name": "durationMillis", - "type": "long" - }, - { - "name": "lineageStart", - "type": { - "type": "long", - "logicalType": "timestamp-millis" - } - }, - { - "name": "details", - "type": [ - "null", - "string" - ] - }, - { - "name": "componentId", - "type": "string" - }, - { - "name": "componentName", - "type": [ - "null", - "string" - ] - }, - { - "name": "componentType", - "type": "string" - }, - { - "name": "entityId", - "type": "string" - }, - { - "name": "entityType", - "type": "string" - }, - { - "name": "entitySize", - "type": [ - "null", - "long" - ] - }, - { - "name": "previousEntitySize", - "type": [ - "null", - "long" - ] - }, - { - "name": "updatedAttributes", - "type": { - "type": "map", - "values": "string" - } - }, - { - "name": "previousAttributes", - "type": { - "type": "map", - "values": "string" - } - }, - { - "name": "actorHostname", - "type": [ - "null", - "string" - ] - }, - { - "name": "contentURI", - "type": [ - "null", - "string" - ] - }, - { - "name": "previousContentURI", - "type": "string" - }, - { - "name": "parentIds", - "type": { - "type": "array", - "items": "string" - } - }, - { - "name": "childIds", - "type": { - "type": "array", - "items": "string" - } - }, - { - "name": "platform", - "type": [ - "null", - "string" - ] - }, - { - "name": "application", - "type": [ - "null", - "string" - ] - }, - { - "name": "transitUri", - "type": [ - "null", - "string" - ] - } - ] -} - + + avro-reg-validated-field-names + + + provenanceEvent + { + "namespace": "nifi", + "name": "provenanceEvent", + "type": "record", + "fields": [ + { + "name": "eventId", + "type": "string" + }, + { + "name": "eventOrdinal", + "type": "long" + }, + { + "name": "eventType", + "type": "string" + }, + { + "name": "timestampMillis", + "type": { + "type": "long", + "logicalType": "timestamp-millis" + } + }, + { + "name": "durationMillis", + "type": "long" + }, + { + "name": "lineageStart", + "type": { + "type": "long", + "logicalType": "timestamp-millis" + } + }, + { + "name": "details", + "type": [ + "null", + "string" + ] + }, + { + "name": "componentId", + "type": "string" + }, + { + "name": "componentName", + "type": [ + "null", + "string" + ] + }, + { + "name": "componentType", + "type": "string" + }, + { + "name": "entityId", + "type": "string" + }, + { + "name": "entityType", + "type": "string" + }, + { + "name": "entitySize", + "type": [ + "null", + "long" + ] + }, + { + "name": "previousEntitySize", + "type": [ + "null", + "long" + ] + }, + { + "name": "updatedAttributes", + "type": { + "type": "map", + "values": "string" + } + }, + { + "name": "previousAttributes", + "type": { + "type": "map", + "values": "string" + } + }, + { + "name": "actorHostname", + "type": [ + "null", + "string" + ] + }, + { + "name": "contentURI", + "type": [ + "null", + "string" + ] + }, + { + "name": "previousContentURI", + "type": "string" + }, + { + "name": "parentIds", + "type": { + "type": "array", + "items": "string" + } + }, + { + "name": "childIds", + "type": { + "type": "array", + "items": "string" + } + }, + { + "name": "platform", + "type": [ + "null", + "string" + ] + }, + { + "name": "application", + "type": [ + "null", + "string" + ] + }, + { + "name": "transitUri", + "type": [ + "null", + "string" + ] + } + ] + } + + DISABLED org.apache.nifi.schemaregistry.services.AvroSchemaRegistry @@ -837,113 +845,115 @@ writer = new GroovyRecordSetWriterFactory() f06c03d8-2716-3f9f-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -nifi-record-serialization-services-nar -org.apache.nifi -1.5.0 + nifi-record-serialization-services-nar + org.apache.nifi + 1.5.0 - - Schema Write Strategy - - Schema Write Strategy - - - - schema-access-strategy - - schema-access-strategy - - - - schema-registry - - org.apache.nifi.schemaregistry.services.SchemaRegistry - schema-registry - - - - schema-name - - schema-name - - - - schema-text - - schema-text - - - - Date Format - - Date Format - - - - Time Format - - Time Format - - - - Timestamp Format - - Timestamp Format - - - - Pretty Print JSON - - Pretty Print JSON - - - - suppress-nulls - - suppress-nulls - - + + Schema Write Strategy + + Schema Write Strategy + + + + schema-access-strategy + + schema-access-strategy + + + + schema-registry + + + org.apache.nifi.schemaregistry.services.SchemaRegistry + + schema-registry + + + + schema-name + + schema-name + + + + schema-text + + schema-text + + + + Date Format + + Date Format + + + + Time Format + + Time Format + + + + Timestamp Format + + Timestamp Format + + + + Pretty Print JSON + + Pretty Print JSON + + + + suppress-nulls + + suppress-nulls + + Write Prov JSON false - - Schema Write Strategy - schema-name - - - schema-access-strategy - schema-name - - - schema-registry - ee4d2c3e-c488-3b95-0000-000000000000 - - - schema-name - provenanceEvent - - - schema-text - ${avro.schema} - - - Date Format - - - Time Format - - - Timestamp Format - - - Pretty Print JSON - false - - - suppress-nulls - + + Schema Write Strategy + schema-name + + + schema-access-strategy + schema-name + + + schema-registry + ee4d2c3e-c488-3b95-0000-000000000000 + + + schema-name + provenanceEvent + + + schema-text + ${avro.schema} + + + Date Format + + + Time Format + + + Timestamp Format + + + Pretty Print JSON + false + + + suppress-nulls + DISABLED org.apache.nifi.json.JsonRecordSetWriter @@ -952,76 +962,78 @@ writer = new GroovyRecordSetWriterFactory() 541bba62-a184-36a4-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -nifi-record-serialization-services-nar -org.apache.nifi -1.5.0 + nifi-record-serialization-services-nar + org.apache.nifi + 1.5.0 - - Schema Write Strategy - - Schema Write Strategy - - - - schema-access-strategy - - schema-access-strategy - - - - schema-registry - - org.apache.nifi.schemaregistry.services.SchemaRegistry - schema-registry - - - - schema-name - - schema-name - - - - schema-text - - schema-text - - - - compression-format - - compression-format - - + + Schema Write Strategy + + Schema Write Strategy + + + + schema-access-strategy + + schema-access-strategy + + + + schema-registry + + + org.apache.nifi.schemaregistry.services.SchemaRegistry + + schema-registry + + + + schema-name + + schema-name + + + + schema-text + + schema-text + + + + compression-format + + compression-format + + Write Prov Avro false - - Schema Write Strategy - avro-embedded - - - schema-access-strategy - schema-name - - - schema-registry - ee4d2c3e-c488-3b95-0000-000000000000 - - - schema-name - provenanceEvent - - - schema-text - ${avro.schema} - - - compression-format - + + Schema Write Strategy + avro-embedded + + + schema-access-strategy + schema-name + + + schema-registry + ee4d2c3e-c488-3b95-0000-000000000000 + + + schema-name + provenanceEvent + + + schema-text + ${avro.schema} + + + compression-format + DISABLED org.apache.nifi.avro.AvroRecordSetWriter @@ -1030,8 +1042,8 @@ writer = new GroovyRecordSetWriterFactory() 56bc5f8b-c556-3fda-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -329.9999996932415 -41.72570281969641 + 329.9999996932415 + 41.72570281969641 1 @@ -1043,62 +1055,62 @@ writer = new GroovyRecordSetWriterFactory() 9001f21d-c558-3d7e-0000-000000000000 a5137dc1-f9fd-3d5a-0000-000000000000 -458.84856060919753 -602.9862663884733 + 458.84856060919753 + 602.9862663884733 -nifi-update-attribute-nar -org.apache.nifi -1.5.0 + nifi-update-attribute-nar + org.apache.nifi + 1.5.0 -WARN - -1 - - - Delete Attributes Expression - - Delete Attributes Expression - - - - Store State - - Store State - - - - Stateful Variables Initial Value - - Stateful Variables Initial Value - - - -ALL -false -30 sec - - - Delete Attributes Expression - - - Store State - Do not store state - - - Stateful Variables Initial Value - - -0 -0 sec -TIMER_DRIVEN -1 sec + WARN + + 1 + + + Delete Attributes Expression + + Delete Attributes Expression + + + + Store State + + Store State + + + + Stateful Variables Initial Value + + Stateful Variables Initial Value + + + + ALL + false + 30 sec + + + Delete Attributes Expression + + + Store State + Do not store state + + + Stateful Variables Initial Value + + + 0 + 0 sec + TIMER_DRIVEN + 1 sec Avro -true -success + true + success STOPPED